Skip to content

Add transition plan for upcoming breaking changes to the unstable HTTP semantic conventions #3404

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.

Sign up for GitHub

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

Closed
trask wants to merge 5 commits into from
Closed

Add transition plan for upcoming breaking changes to the unstable HTTP semantic conventions #3404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32c5197
Add transition plan for upcoming breaking changes to the unstable HTT…
trask Apr 17, 2023
f2c15d6
Add time period before stable release
trask Apr 18, 2023
bb8ac7d
Two options
trask Apr 24, 2023
f2e9f4d
Merge branch 'main' into transition-plan-2
trask Apr 24, 2023
f1ed5ec
Merge branch 'main' into transition-plan-2
trask Apr 26, 2023
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ release.
([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
- BREAKING: Remove `messaging.consumer.id`, make `messaging.client_id` generic
([#3336](https://github.com/open-telemetry/opentelemetry-specification/pull/3336))
- 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
15 changes: 15 additions & 0 deletions specification/metrics/semantic_conventions/http-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,21 @@ 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 either:
>
> * wait to update until at least October 1, 2023, or
> * bump their major version and wait to release a stable version of the new major
> version until at least October 1, 2023.
>
> In both cases, the minor version prior to the update SHOULD be supported until
> February 1, 2024 (e.g. at least security patches).

## HTTP Server

### Metric: `http.server.duration`
Expand Down
15 changes: 15 additions & 0 deletions specification/trace/semantic_conventions/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,21 @@ 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.
Comment on lines +31 to +32
Copy link
Member

@arminru arminru Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the breaking changes were already released in 1.20.0 and 1.19.0:

  • Rename net.app.protocol.(name|version) to net.protocol.(name|version) (#3272)
  • Replace http.flavor with net.protocol.(name|version) (#3272)
  • Remove http.status_code attribute from the http.server.active_requests metric. (#3366)
  • Rename http.user_agent to user_agent.original. (#3190)

We could extend the guidance here to cover this, at least for those libraries that did not already update in the meantime.

>
> 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 either:
>
> * wait to update until at least October 1, 2023, or
> * bump their major version and wait to release a stable version of the new major
> version until at least October 1, 2023.
>
> In both cases, the minor version prior to the update SHOULD be supported until
> February 1, 2024 (e.g. at least security patches).

## Name

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