Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify enum attribute value stability guarantees #3879

Merged
merged 9 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ release.

### Common

- Clarify stability requirements for enum attribute values
pyohannes marked this conversation as resolved.
Show resolved Hide resolved
([#3879](https://github.com/open-telemetry/opentelemetry-specification/pull/3879))

### Supplementary Guidelines

## v1.29.0 (2024-01-10)
Expand Down
11 changes: 7 additions & 4 deletions specification/versioning-and-stability.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,16 +183,19 @@ Semantic Conventions defines the set of fields in the OTLP data model:
- Attribute keys
- provided to [get a tracer](trace/api.md#get-a-tracer)
- provided to [get a meter](metrics/api.md#get-a-meter)
- Attribute values that are defined as `enums`
- [Trace](trace/api.md)
- The following data on [span](trace/api.md#span):
- The span name
- The span kind
- The attribute keys provided to the span
- Whether these attributes must be provided at span start time, due to
sampling concerns.
- The attribute values provided to the span that are defined as `enums`.
pyohannes marked this conversation as resolved.
Show resolved Hide resolved
- The following data provided on [span events](trace/api.md#add-events)
- The event name
- The attribute keys provided for the event
- The attribute values provided for the event that are defined as `enums`
- [Metrics](metrics/api.md)
- The following portions of a Metric
(passed when constructing [an instrument](metrics/api.md#instrument)):
Expand All @@ -207,8 +210,10 @@ Semantic Conventions defines the set of fields in the OTLP data model:
both synchronous and asynchronous instruments.
- These exist on `NumberDataPoint`, `HistogramDataPoint`,
`ExponentialHistogramDataPoint` and `SummaryDataPoint`.
- The attribute values on any `*DataPoint` that are defined as `enums`.
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
- [Log Records](logs/data-model.md#log-and-event-record-definition)
- The attribute keys provided on the LogRecord
- The attribute values provided on the LogRecord that are defined as `enums`
- For log records that are [Log Events](logs/event-api.md)
- The following data provided to [emit event](logs/event-api.md#emit-event):
- The event name (the value of the `event.name` attribute)
Expand All @@ -217,10 +222,8 @@ Things not listed in the above are not expected to remain stable via semantic
convention and are allowed (or expected) to change. A few examples:

- The values of attributes
- Specifically for `enums` the list of allowed values is expected to change
overtime.
- Even for `enums` that limit allowed values to semconv, some may need to
updated values in the future. Tooling should expect unknown values.
- An exception are existing values for `enums`. However, new values for
`enums` can be added. Tooling should expect unknown values.
pyohannes marked this conversation as resolved.
Show resolved Hide resolved
- The links attached to a span
- The recorded measurement type (float or integer) of a metric is not enforced and allowed to change.
- The description of a metric instrument.
Expand Down
Loading