-
Notifications
You must be signed in to change notification settings - Fork 167
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
[WIP] Define semantic convention group and mixed stability rules #1472
base: main
Are you sure you want to change the base?
Conversation
**Experimental groups:** | ||
|
||
- MAY add or remove references to stable or experimental attributes | ||
- MAY change requirement level and other properties of attribute references |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Subject to more specific rules, e.g. metric groups where you CANNOT change requirement_level without it being a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is allow-list for experimental groups - breaking, but allowed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I initially called it out in the stable group list below, but then decided that stable groups + stable attributes guarantees would belong in the https://github.com/open-telemetry/opentelemetry-specification/blob/0a78571045ca1dca48621c9648ec3c832c3c541c/specification/versioning-and-stability.md?plain=1#L217. WDYT?
|
||
**Stable groups:** | ||
|
||
- MAY add or remove references to stable or experimental attributes with `opt_in` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removing stable opt-in is breaking
|
||
- MAY add or remove references to stable or experimental attributes with `opt_in` | ||
requirement level regardless of attribute stability. | ||
- MUST NOT have references to experimental attributes with requirement level |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need to make it some exceptions for service
and telemetry.sdk
and maybe some other since they are populated by default
Stable instrumentations MUST NOT report telemetry following the experimental part | ||
of semantic conventions by default. They MAY support experimental part and allow | ||
users to opt into it. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
future: publish two schemas - stable and stable+experimental (e.g. 1.28.0
and 1.28.0-dev
)
Fixes #906.
Related: #1423
Key points:
Merge requirement checklist
[chore]