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

Mark HTTP semantic conventions as stable #377

Merged
merged 6 commits into from
Nov 3, 2023

Conversation

lmolkova
Copy link
Contributor

@lmolkova lmolkova commented Oct 10, 2023

Fixes #82

Merge requirement checklist

@lmolkova
Copy link
Contributor Author

lmolkova commented Oct 10, 2023

some limitations we have in the md generator (and can address separately):

  • only the original definition (in the registry) has a badge, referenced attributes don't get it
  • semconv group in yaml cannot be marked as stable as a whole
  • metrics don't have stability levels in yaml

@AlexanderWert
Copy link
Member

@lmolkova WDYT about rendering deprecated labels as well? Though I see that deprecated attributes have it also in their brief / description: Deprecated, use ... instead.

@lmolkova
Copy link
Contributor Author

@lmolkova WDYT about rendering deprecated labels as well? Though I see that deprecated attributes have it also in their brief / description: Deprecated, use ... instead.

They seem to be rendered by default - https://github.com/open-telemetry/build-tools/blob/370e8f443612b312d9d30679f4cd513152fdab1b/semantic-conventions/src/opentelemetry/semconv/main.py#L210

We just never use them in markdown, so they don't appear. If we did, they'd appear as
image

model/registry/http.yaml Outdated Show resolved Hide resolved
model/registry/http.yaml Outdated Show resolved Hide resolved
@trask
Copy link
Member

trask commented Oct 31, 2023

@lmolkova can you expand this PR to also update the stability of the http spans page and relevant metrics sections, so that it will be the one PR that we merge related to marking things stable? thx

@lmolkova lmolkova changed the title Mark HTTP and related attributes as stable and render badges Mark HTTP and related attributes stable and update semconv status Nov 1, 2023
CHANGELOG.md Outdated Show resolved Hide resolved
@trask trask marked this pull request as ready for review November 2, 2023 18:16
@trask trask requested review from a team November 2, 2023 18:16
@trask trask changed the title Mark HTTP and related attributes stable and update semconv status Mark HTTP semantic conventions as stable Nov 2, 2023
@Oberon00
Copy link
Member

Oberon00 commented Nov 3, 2023

I have been asked to review this PR, I can (only) confirm that as far as I know, there are no blockers left for stability so probably this is good to go. But I haven't been following the spec/semconv work closely enough recently to add a formal review here.

@jsuereth jsuereth merged commit 09b0b64 into open-telemetry:main Nov 3, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Mark HTTP semantic conventions as stable in the YAML definitions
7 participants