Skip to content

Commit 1382c50

Browse files
committed
Transition plan where both old and new attributes are sent for a while
1 parent bc61ad5 commit 1382c50

3 files changed

Lines changed: 30 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ release.
4343
([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
4444
- BREAKING: Remove `messaging.consumer.id`, make `messaging.client_id` generic
4545
([#3336](https://github.com/open-telemetry/opentelemetry-specification/pull/3336))
46+
- Add transition plan for upcoming breaking changes to the unstable HTTP semantic
47+
conventions.
48+
([#3443](https://github.com/open-telemetry/opentelemetry-specification/pull/3443))
4649

4750
### Compatibility
4851

specification/metrics/semantic_conventions/http-metrics.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ operations. By adding HTTP attributes to metric events it allows for finely tune
2626

2727
<!-- tocstop -->
2828

29+
> **Warning**
30+
> HTTP instrumentation updating from
31+
> [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/metrics/semantic_conventions/http-metrics.md)
32+
> (or prior) to the latest version SHOULD:
33+
>
34+
> * start emitting the latest semantic convention attributes on HTTP metrics
35+
> _in addition_ to the attributes they are already emitting,
36+
> without bumping the major version.
37+
> (note: this SHOULD NOT increase cardinality or create new timeseries)
38+
> * maintain (security patching at a minimum) the existing major version
39+
> for at least six months after it starts emitting both sets of attributes.
40+
> * stop emitting the old set of attributes in the next major version (stable
41+
> next major version SHOULD NOT be released prior to October 1, 2023).
42+
2943
## HTTP Server
3044

3145
### Metric: `http.server.duration`

specification/trace/semantic_conventions/http.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ and various HTTP versions like 1.1, 2 and SPDY.
2727

2828
<!-- tocstop -->
2929

30+
> **Warning**
31+
> HTTP instrumentation updating from
32+
> [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md)
33+
> (or prior) to the latest version SHOULD:
34+
>
35+
> * start emitting the latest semantic convention attributes on spans
36+
> _in addition_ to the attributes they are already emitting,
37+
> without bumping the major version.
38+
> * maintain (security patching at a minimum) the existing major version
39+
> for at least six months after it starts emitting both sets of attributes.
40+
> * stop emitting the old set of attributes in the next major version (stable
41+
> next major version SHOULD NOT be released prior to October 1, 2023).
42+
3043
## Name
3144

3245
HTTP spans MUST follow the overall [guidelines for span names](../api.md#span).

0 commit comments

Comments
 (0)