Skip to content

Commit

Permalink
telemetry.distro.name and telemetry.distro.version (#178)
Browse files Browse the repository at this point in the history
Co-authored-by: Reiley Yang <reyang@microsoft.com>
  • Loading branch information
zeitlinger and reyang committed Oct 5, 2023
1 parent 5181f04 commit b33f2fc
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 5 additions & 1 deletion docs/resource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,11 @@ All custom identifiers SHOULD be stable across different versions of an implemen
<!-- semconv telemetry_experimental -->
| 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`.
<!-- endsemconv -->

## Compute Unit
Expand Down
12 changes: 10 additions & 2 deletions model/resource/telemetry_experimental.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
6 changes: 6 additions & 0 deletions schema-next.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit b33f2fc

Please sign in to comment.