forked from open-telemetry/opentelemetry-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document recommendations around semantic conventions (open-telemetry#94)
* Document recommendations around semantic conventions * Update specification/semantic_conventions.md Co-authored-by: Mateusz Rzeszutek <[email protected]> Co-authored-by: Mateusz Rzeszutek <[email protected]>
- Loading branch information
Showing
2 changed files
with
28 additions
and
0 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,27 @@ | ||
# Semantic Conventions | ||
|
||
This document defines the OpenTelemetry and Splunk specific standard attributes for Splunk distributions of OpenTelemetry. | ||
|
||
## OpenTelemetry Resource Attributes | ||
|
||
**Description:** Required and recommended OpenTelemetry [resource semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk). | ||
|
||
All Splunk distributions of OpenTelemetry, | ||
|
||
- MUST set the following OpenTelemetry resource attributes according to the [OpenTelemetry Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk): | ||
- `telemetry.sdk.name` | ||
- `telemetry.sdk.version` | ||
- `telemetry.sdk.language` | ||
|
||
- SHOULD set the following resource attributes when applicable: | ||
- `telemetry.auto.version` | ||
|
||
|
||
## Splunk Resource Attributes | ||
|
||
**Description:** Set of attributes used to uniquely identify a Splunk distro version in combination with OpenTelemetry's `telemetry.sdk.*` attributes. | ||
|
||
|
||
| Attribute | Type | Description | Examples | Required | | ||
|---|---|---|---|---| | ||
| `splunk.distro.version` | string | The version number of the Splunk distribution being used. | `1.5.0` | Yes | |