Skip to content
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

Stabilizing otel.experimental.resource.disabled.keys #6809

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

vasantteja
Copy link
Contributor

I kept otel.experimental.resource.disabled.keys for backwards compatibility and promoted them to a newer stabilized version as otel.resource.disabled.keys. Please take a look and let me know if this looks good. This resolves 6777

@vasantteja vasantteja requested a review from a team as a code owner October 21, 2024 12:15
Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (680c940) to head (453d282).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #6809      +/-   ##
============================================
+ Coverage     90.36%   90.37%   +0.01%     
- Complexity     6576     6579       +3     
============================================
  Files           731      731              
  Lines         19714    19720       +6     
  Branches       1926     1928       +2     
============================================
+ Hits          17814    17822       +8     
+ Misses         1302     1300       -2     
  Partials        598      598              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note, we'll need to update the autoconfigure docs on opentelemetry.io when this is released.

@vasantteja
Copy link
Contributor Author

Note, we'll need to update the autoconfigure docs on opentelemetry.io when this is released.

Yeah I was thinking of updating the docs and creating another feature to deprecate the experimental feature in next major release. How does this sound?

@jack-berg
Copy link
Member

Yeah I was thinking of updating the docs and creating another feature to deprecate the experimental feature in next major release. How does this sound?

I opened #6811 to add "updating the docs" as a release step, so I can go ahead and update the docs when I do the next release. If we were to go update the docs now, users might get confused because the new property name isn't actually released yet.

As for deprecating the experimental property name, I'd say that this PR is the deprecation. We typically keep deprecated experimental features around a couple of minor releases, but no reason to wait for a major release to do this. We have no plans to release a new major version so waiting for this would essentially be waiting indefinitely.

disabledAttibuteKeys = configProperties.getList(EXPERIMENTAL_DISABLED_ATTRIBUTE_KEYS);
if (!disabledAttibuteKeys.isEmpty()) {
logger.warning(
"otel.experimental.resource.disabled.keys is deprecated. Please use otel.resource.disabled.keys instead.");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we warn users that it will be removed after the 1.45.0 release, which is 3 releases?

Suggested change
"otel.experimental.resource.disabled.keys is deprecated. Please use otel.resource.disabled.keys instead.");
"otel.experimental.resource.disabled.keys is deprecated and will be removed after 1.45.0 release. Please use otel.resource.disabled.keys instead.");

Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider being explicit about when we plan to remove, but otherwise looks good. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stabilize otel.experimental.resource.disabled.keys
3 participants