Skip to content

Mark HTTP semantic conventions as stable#377

Merged
jsuereth merged 6 commits intoopen-telemetry:mainfrom
lmolkova:http-stable-badges
Nov 3, 2023
Merged

Mark HTTP semantic conventions as stable#377
jsuereth merged 6 commits intoopen-telemetry:mainfrom
lmolkova:http-stable-badges

Conversation

@lmolkova
Copy link
Copy Markdown
Member

@lmolkova lmolkova commented Oct 10, 2023

Fixes #82

Merge requirement checklist

@lmolkova
Copy link
Copy Markdown
Member 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
Copy Markdown
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
Copy Markdown
Member 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

@trask
Copy link
Copy Markdown
Member

trask commented Oct 31, 2023

@trask
Copy link
Copy Markdown
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
@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
Copy Markdown
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.

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