open-telemetry / opentelemetry-specification

Specifications for OpenTelemetry
https://opentelemetry.io
Apache License 2.0
3.73k stars 888 forks source link

Conditions to rename attributes, metrics, and events in stable semconv #3513

Open lmolkova opened 1 year ago

lmolkova commented 1 year ago

Currently, spec allows to rename things:

https://github.com/open-telemetry/opentelemetry-specification/blob/4229197f45f0da0642bc7c0127e84c8aa1439489/specification/versioning-and-stability.md?plain=1#L233-L239

After attribute/semantic convention reaches stability, there is very little benefit in renaming attributes, metrics, or events.

Even though schema transformation can hypothetically patch old data and align it with newer version, it would not help custom tooling: custom queries, alerts, and dashboards that are built on top of old schema.

Given that risks and complexity are high and benefits are low, should we keep allowing renames? If so, we should define the bar and clarify that rename is an exceptional thing.

trask commented 5 months ago

(related: https://github.com/open-telemetry/opentelemetry-specification/pull/3380)