Skip to content
New issue

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

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

Already on GitHub? # to your account

Add http semantic conventions notice to changelog #6737

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dmathieu
Copy link
Member

@dmathieu dmathieu commented Feb 7, 2025

Closes #6731

@dmathieu dmathieu added this to the v1.35.0 milestone Feb 7, 2025
@dmathieu dmathieu marked this pull request as ready for review February 7, 2025 09:09
@dmathieu dmathieu requested a review from a team as a code owner February 7, 2025 09:09
@dmathieu
Copy link
Member Author

dmathieu commented Feb 7, 2025

We should wait for #6710 to be merged before merging this one.

CHANGELOG.md Outdated
@@ -8,11 +8,24 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased]

### ⚠️ Notice ⚠️
Copy link
Contributor

Choose a reason for hiding this comment

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

This shouldn't be it's own section.

What about alert syntax?

Copy link
Member Author

Choose a reason for hiding this comment

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

I have moved it to the deprecated section with a warning.

CHANGELOG.md Outdated
Comment on lines 31 to 41
> [!WARNING]
> This is the last version to use Semantic Conventions v1.20.0 for HTTP libraries
by default. The next version (0.61.0) will default to v1.26.0, and the
following one (0.62.0) will drop support for Semantic Conventions v1.20.0
>
> You can switch to the new Semantic Conventions right now by setting the
`OTEL_HTTP_CLIENT_COMPATIBILITY_MODE=http/dup` environment variable in your
application.
>
> See also the [HTTP semantic conventions stability
migration](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md)
Copy link
Member

Choose a reason for hiding this comment

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

I suggest putting this in the beginning of the changelog for given version. I mean just before ### Added.

Copy link
Member Author

Choose a reason for hiding this comment

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

That's what I did at first. But @MrAlias seems to want it into another section.

Copy link
Member

Choose a reason for hiding this comment

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

@MrAlias said the opposite.

This shouldn't be it's own section.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure what @MrAlias intended, so I've moved it back to the top of the changelog.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a warning to the changelog for the upcoming HTTP migration
3 participants