-
-
Notifications
You must be signed in to change notification settings - Fork 168
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resolved #635 by adding a new LoggerRestResource that can be used by …
…external systems to store logging data in Salesforce, using OpenTelemetry's logs data model
- Loading branch information
Showing
23 changed files
with
989 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
--- | ||
layout: default | ||
--- | ||
|
||
## LoggerRestResource class | ||
|
||
REST Resource class for external integrations to interact with Nebula Logger | ||
|
||
--- | ||
|
||
### Properties | ||
|
||
#### `body` → `String` | ||
|
||
#### `endpointRequest` → `EndpointRequest` | ||
|
||
#### `errors` → `List<EndpointError>` | ||
|
||
#### `headerKeys` → `List<String>` | ||
|
||
#### `httpMethod` → `String` | ||
|
||
#### `isSuccess` → `Boolean` | ||
|
||
#### `message` → `String` | ||
|
||
#### `name` → `String` | ||
|
||
#### `parameters` → `Map<String, String>` | ||
|
||
#### `particle` → `String` | ||
|
||
#### `statusCode` → `Integer` | ||
|
||
#### `type` → `String` | ||
|
||
#### `uri` → `String` | ||
|
||
--- | ||
|
||
### Methods | ||
|
||
#### `EndpointError(System.Exception apexException)` → `public` | ||
|
||
#### `EndpointError(String message)` → `public` | ||
|
||
#### `EndpointError(String message, String type)` → `public` | ||
|
||
#### `EndpointRequest(System.RestRequest restRequest)` → `public` | ||
|
||
#### `addError(System.Exception apexException)` → `EndpointResponse` | ||
|
||
#### `addError(EndpointError endpointError)` → `EndpointResponse` | ||
|
||
#### `handlePost()` → `void` | ||
|
||
Processes any HTTP POST requests sent | ||
|
||
#### `handlePost(EndpointRequest endpointRequest)` → `EndpointResponse` | ||
|
||
#### `handlePost(EndpointRequest endpointRequest)` → `EndpointResponse` | ||
|
||
#### `handlePost(EndpointRequest endpointRequest)` → `EndpointResponse` | ||
|
||
#### `setStatusCode(Integer statusCode)` → `EndpointResponse` | ||
|
||
--- | ||
|
||
### Inner Classes | ||
|
||
#### LoggerRestResource.OTelAttribute class | ||
|
||
--- | ||
|
||
##### Constructors | ||
|
||
###### `OTelAttribute(String key, String value)` | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `key` → `String` | ||
|
||
###### `value` → `OTelAttributeValue` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelAttributeValue class | ||
|
||
--- | ||
|
||
##### Constructors | ||
|
||
###### `OTelAttributeValue(String value)` | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `stringValue` → `String` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelLogRecord class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `attributes` → `List<OTelAttribute>` | ||
|
||
###### `body` → `OTelAttributeValue` | ||
|
||
###### `severityText` → `String` | ||
|
||
###### `timeUnixNano` → `String` | ||
|
||
--- | ||
|
||
##### Methods | ||
|
||
###### `getLogEntryEvent()` → `LogEntryEvent__e` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelLogsPayload class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `resourceLogs` → `List<OTelResourceLog>` | ||
|
||
--- | ||
|
||
##### Methods | ||
|
||
###### `getConvertedLogEntryEvents()` → `List<LogEntryEvent__e>` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelResource class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `attributes` → `List<OTelAttribute>` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelResourceLog class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `resource` → `OTelResource` | ||
|
||
###### `scopeLogs` → `List<OTelScopeLog>` | ||
|
||
--- | ||
|
||
##### Methods | ||
|
||
###### `getLogEntryEvents()` → `List<LogEntryEvent__e>` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelScope class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `name` → `String` | ||
|
||
###### `version` → `String` | ||
|
||
--- | ||
|
||
#### LoggerRestResource.OTelScopeLog class | ||
|
||
--- | ||
|
||
##### Properties | ||
|
||
###### `logRecords` → `List<OTelLogRecord>` | ||
|
||
###### `scope` → `OTelScope` | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.