Skip to content

Commit

Permalink
Document recommendations around semantic conventions (open-telemetry#94)
Browse files Browse the repository at this point in the history
* 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
owais and Mateusz Rzeszutek authored May 19, 2021
1 parent 2e3c3a6 commit 3bf455d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ expectations. It is applicable to GDI projects.
The following components are currently in scope:

- [Configuration](specification/configuration.md)
- [Semantic Conventions](specification/semantic_conventions.md)
- [Repository](specification/repository.md)
- [Versioning](specification/versioning.md)

Expand Down
27 changes: 27 additions & 0 deletions specification/semantic_conventions.md
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 |

0 comments on commit 3bf455d

Please sign in to comment.