From 6241d95cc59681daac49e3c71234fd291fd76f48 Mon Sep 17 00:00:00 2001 From: gregor Date: Fri, 7 Jul 2023 13:24:50 +0200 Subject: [PATCH] rename telemetry.auto.name to telemetry.distro.name and add telemetry.distro.version --- CHANGELOG.md | 3 +++ docs/resource/README.md | 6 +++++- model/resource/telemetry_experimental.yaml | 12 ++++++++++-- schema-next.yaml | 6 ++++++ 4 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d93c97e1bf..5e010a3da2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -129,6 +129,9 @@ release. ([#350](https://github.com/open-telemetry/semantic-conventions/pull/350)) - Improve network attribute briefs. ([#352](https://github.com/open-telemetry/semantic-conventions/pull/352)) +- BREAKING: Rename `telemetry.auto.version` resource attribute to `telemetry.distro.version` + and add `telemetry.distro.name` resource attribute + ([#178](https://github.com/open-telemetry/semantic-conventions/pull/178)) ## v1.21.0 (2023-07-13) diff --git a/docs/resource/README.md b/docs/resource/README.md index 312200f716..d0a4a272dc 100644 --- a/docs/resource/README.md +++ b/docs/resource/README.md @@ -172,7 +172,11 @@ All custom identifiers SHOULD be stable across different versions of an implemen | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `telemetry.auto.version` | string | The version string of the auto instrumentation agent, if used. | `1.2.3` | Recommended | +| `telemetry.distro.name` | string | The name of the auto instrumentation agent or distribution, if used. [1] | `parts-unlimited-java` | Recommended | +| `telemetry.distro.version` | string | The version string of the auto instrumentation agent or distribution, if used. | `1.2.3` | Recommended | + +**[1]:** Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to +a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. ## Compute Unit diff --git a/model/resource/telemetry_experimental.yaml b/model/resource/telemetry_experimental.yaml index 6313705517..8f7b23554b 100644 --- a/model/resource/telemetry_experimental.yaml +++ b/model/resource/telemetry_experimental.yaml @@ -5,8 +5,16 @@ groups: brief: > The telemetry SDK used to capture data recorded by the instrumentation libraries. attributes: - - id: auto.version + - id: distro.name type: string brief: > - The version string of the auto instrumentation agent, if used. + The name of the auto instrumentation agent or distribution, if used. + note: | + Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to + a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. + examples: ["parts-unlimited-java"] + - id: distro.version + type: string + brief: > + The version string of the auto instrumentation agent or distribution, if used. examples: ["1.2.3"] diff --git a/schema-next.yaml b/schema-next.yaml index 4fecff3b2e..066a9ce9ef 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -135,6 +135,12 @@ versions: - rename_metrics: http.server.request.size: http.server.request.body.size http.server.response.size: http.server.response.body.size + resources: + changes: + # https://github.com/open-telemetry/semantic-conventions/pull/178 + - rename_attributes: + attribute_map: + telemetry.auto.version: telemetry.distro.version 1.21.0: spans: changes: