From 3bf455d64ed634181fb267151aea81fb2cb879d5 Mon Sep 17 00:00:00 2001 From: Owais Lone Date: Wed, 19 May 2021 20:45:08 +0530 Subject: [PATCH] Document recommendations around semantic conventions (#94) * Document recommendations around semantic conventions * Update specification/semantic_conventions.md Co-authored-by: Mateusz Rzeszutek Co-authored-by: Mateusz Rzeszutek --- README.md | 1 + specification/semantic_conventions.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 specification/semantic_conventions.md diff --git a/README.md b/README.md index d2ba0f93be1..5b486a6bec4 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/specification/semantic_conventions.md b/specification/semantic_conventions.md new file mode 100644 index 00000000000..9072d5ef749 --- /dev/null +++ b/specification/semantic_conventions.md @@ -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 |