[chore] System Semconv Description Guidance #2826
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR explains how the `brief` and `note` fields will be used in the namespaces covered by the System Semantic Conventions group. The general concept is that we want to assume a baseline level of knowledge for readers of our conventions, as this frees us up to focus the descriptions of our instrumentation on instrumentation details rather than on explaining general concepts.
trask
approved these changes
Sep 29, 2025
ChrsMark
approved these changes
Sep 30, 2025
github-project-automation
bot
moved this from Untriaged
to Needs More Approval
in Semantic Conventions Triage
jsuereth
approved these changes
Sep 30, 2025
joaopgrassi
approved these changes
Oct 6, 2025
joaopgrassi
moved this from Needs More Approval
to Ready to be Merged
in Semantic Conventions Triage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR explains how the
briefandnotefields will be used in the namespaces covered by the System Semantic Conventions group.The general concept is that we want to assume a baseline level of knowledge for readers of our conventions, as this frees us up to focus the descriptions of our instrumentation on instrumentation details rather than on explaining general concepts.
The guidance in this PR may not be consistently followed in our conventions as of writing, and will be aligned as part of our stabilization efforts.
Merge requirement checklist
[chore]