Skip to content
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.

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

Confirming it's ok to mark HTTP semconv stable without marking net.* attributes stable #3260

Closed
trask opened this issue Feb 28, 2023 · 2 comments · Fixed by #3278
Closed
Assignees
Labels
area:semantic-conventions Related to semantic conventions semconv:HTTP

Comments

@trask
Copy link
Member

trask commented Feb 28, 2023

The HTTP semconv stability working group believes that it's ok to mark HTTP semconv as stable without marking any part of span general semconv as stable.

But we would like to make sure that there's broader community agreement on this point and discuss if there is any disagreement.

What we believe is that by marking HTTP semconv as stable, we will be marking the net.* attributes that are used in the HTTP semconv as stable within the context of HTTP semantic conventions, with the HTTP-specific definitions of them which appear in the HTTP semconv.

This will inherently place a barrier to changing these attribute names in the span general semconv, but at the same time it leaves some flexibility in the precise definition of these attributes at the more abstract/general net.* level.

@Oberon00
Copy link
Member

Oberon00 commented Feb 28, 2023

I think we should at least split out a part of the net conventions needed for HTTP and mark it as stable (if we don't want to mark them as stable completely). Otherwise it becomes a bit too subtle.

@trask
Copy link
Member Author

trask commented Feb 28, 2023

Discussed in the spec meeting and there is desire to at least mark attributes in span general that are used by stable HTTP semantic conventions, so it's clear that the changes allowed to them are limited.

@trask trask assigned trask and unassigned tigrannajaryan Mar 1, 2023
tigrannajaryan added a commit that referenced this issue Apr 6, 2023
)

Fixes #3260

(a first try at least)

## Changes

Splits `net.*` attributes into two sections, and adds this warning to
the attributes in the first section:

> **Warning** Most of the attributes in this section are in use by the
HTTP semantic conventions.
Once the HTTP semantic conventions are declared stable, changes to the
attributes in this section will only be allowed
if they do not cause breaking changes to HTTP semantic conventions.

Co-authored-by: Liudmila Molkova <[email protected]>
Co-authored-by: Carlos Alberto Cortez <[email protected]>
Co-authored-by: Tigran Najaryan <[email protected]>
@github-project-automation github-project-automation bot moved this from Blocker for stability to Done in Spec: HTTP Semantic Conventions Apr 6, 2023
carlosalberto added a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 31, 2024
…en-telemetry#3278)

Fixes open-telemetry#3260

(a first try at least)

## Changes

Splits `net.*` attributes into two sections, and adds this warning to
the attributes in the first section:

> **Warning** Most of the attributes in this section are in use by the
HTTP semantic conventions.
Once the HTTP semantic conventions are declared stable, changes to the
attributes in this section will only be allowed
if they do not cause breaking changes to HTTP semantic conventions.

Co-authored-by: Liudmila Molkova <[email protected]>
Co-authored-by: Carlos Alberto Cortez <[email protected]>
Co-authored-by: Tigran Najaryan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions semconv:HTTP
Projects
Development

Successfully merging a pull request may close this issue.

3 participants