[events] refine general event semantics documentation#3030
Merged
lmolkova merged 10 commits intoopen-telemetry:mainfrom Nov 20, 2025
Merged
[events] refine general event semantics documentation#3030lmolkova merged 10 commits intoopen-telemetry:mainfrom
lmolkova merged 10 commits intoopen-telemetry:mainfrom
Conversation
Member
Author
|
I do not think this needs a changelog. Feel free to remove the label if you disagree. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines the documentation for OpenTelemetry Events to improve clarity and better align with semantic conventions standards. The changes reorganize and consolidate event requirements while maintaining technical accuracy.
- Consolidated event definition requirements into a clearer structure
- Improved the phrasing of event semantics to be more concise and consistent with RFC 2119 keywords
- Enhanced guidance for external event compatibility scenarios
Clarified guidelines on event details and body usage.
lmolkova
reviewed
Nov 4, 2025
Co-authored-by: Liudmila Molkova <[email protected]>
cijothomas
reviewed
Nov 5, 2025
cijothomas
reviewed
Nov 5, 2025
trask
approved these changes
Nov 6, 2025
lmolkova
reviewed
Nov 6, 2025
Member
lmolkova
left a comment
There was a problem hiding this comment.
didn't realize I had pending comments, posing now
Removed redundant phrases and clarified semantic conventions for events.
lmolkova
approved these changes
Nov 19, 2025
trask
approved these changes
Nov 19, 2025
bachgarash
pushed a commit
to bachgarash/semantic-conventions
that referenced
this pull request
Nov 28, 2025
…#3030) Co-authored-by: Liudmila Molkova <[email protected]>
jsuereth
pushed a commit
to jsuereth/semantic-conventions
that referenced
this pull request
Dec 2, 2025
…#3030) Co-authored-by: Liudmila Molkova <[email protected]>
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
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.
Towards stabilization of https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md
Fixes #1651
Changes
This PR refines the documentation for general event semantics to improve clarity and structure.
Documentation improvements
Requirement level clarifications
Technical changes
Rationale
The changes improve developer experience by: