-
Notifications
You must be signed in to change notification settings - Fork 889
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
Rename Optional attribute requirement level to Opt-In #3228
Conversation
Copying my comment from open-telemetry/build-tools#135 (comment): There is actually a definition of our "optional" requirement level that says it's "opt-in": https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/attribute-requirement-level.md#optional
opt-in was also the original name this was proposed with in #2522 by @lmolkova, but @bogdandrutu requested reanaming it to "optional" in #2522 (comment):
Personally, I would also still find "opt-in" clearer than "optional" |
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.
You need to also change the definition at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/attribute-requirement-level.md#optional
I concur with @Oberon00: When specifying semantic conventions, we need to have different nuances for specifying the requirement (or not) of an attribute:
For Recommended and Optional, we could have a separate qualifier (e.g. Opt-in and Opt-out) which indicates whether this attribute can be enabled or disabled manually by the user (e.g. an IP address, a local file path, etc. for security reasons). |
I wasn't suggesting to add an additional opt-out level. I think that's too fine grained and you should decide between "recommended" and "opt-in". I actually concur with this PR which stays with our current number of levels and just renames the "optional" level to better match its definition. |
Fixes #3227
Changes
Renames "Optional" attribute requirement level to "Opt-In", to better reflect it's meaning.
For non-trivial changes, follow the change proposal process and link to the related issue(s) and/or OTEP(s), update the
CHANGELOG.md
, and also be sure to updatespec-compliance-matrix.md
if necessary.