Skip to content

Commit

Permalink
Add transition plan for upcoming breaking changes to the unstable HTT…
Browse files Browse the repository at this point in the history
…P semantic conventions
  • Loading branch information
trask committed Apr 17, 2023
1 parent 90007a1 commit 32c5197
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ release.
([#3388](https://github.com/open-telemetry/opentelemetry-specification/pull/3388))
- Change http.server.duration and http.client.duration units to seconds
([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
- Add transition plan for upcoming breaking changes to the unstable HTTP semantic
conventions.
([#3404](https://github.com/open-telemetry/opentelemetry-specification/pull/3404))

### Compatibility

Expand Down
14 changes: 14 additions & 0 deletions specification/metrics/semantic_conventions/http-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,20 @@ operations. By adding HTTP attributes to metric events it allows for finely tune

<!-- tocstop -->

> **Warning**
> v1.21.0 of this document will introduce significant breaking changes to the (not yet stable)
> HTTP semantic conventions.
>
> HTTP instrumentations updating from
> [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/metrics/semantic_conventions/http-metrics.md)
> (or prior) to this new version SHOULD bump their major version
> even though the instrumentation has not been declared stable.
> And the previous major version SHOULD be supported until February 1, 2024
> (e.g. at least security patches).
>
> This major version bump will signal that users should take care when upgrading the
> instrumentation, including verifying whether their backend supports the new major version.
## HTTP Server

### Metric: `http.server.duration`
Expand Down
14 changes: 14 additions & 0 deletions specification/trace/semantic_conventions/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,20 @@ and various HTTP versions like 1.1, 2 and SPDY.

<!-- tocstop -->

> **Warning**
> v1.21.0 of this document will introduce significant breaking changes to the (not yet stable)
> HTTP semantic conventions.
>
> HTTP instrumentations updating from
> [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md)
> (or prior) to this new version SHOULD bump their major version
> even though the instrumentation has not been declared stable.
> And the previous major version SHOULD be supported until February 1, 2024
> (e.g. at least security patches).
>
> This major version bump will signal that users should take care when upgrading the
> instrumentation, including verifying whether their backend supports the new major version.
## Name

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

0 comments on commit 32c5197

Please sign in to comment.