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

Update Docs with right contract of MeterFilter #5480

Open
lenin-jaganathan opened this issue Sep 18, 2024 · 2 comments
Open

Update Docs with right contract of MeterFilter #5480

lenin-jaganathan opened this issue Sep 18, 2024 · 2 comments
Labels
doc-update A documentation update
Milestone

Comments

@lenin-jaganathan
Copy link
Contributor

Until 1.13 the meter filters are executed every time the builder is called. This was changed in 1.13.x to provide performance benefits while using builders. This has broken the use-cases where MeterFilters were used to add dynamic content to metrics from a local context/threadlocals etc. Make this change explicit in the docs so that users have right expectation for MeterFilters.

@shakuzen shakuzen added the doc-update A documentation update label Sep 20, 2024
@shakuzen shakuzen added this to the 1.12.x milestone Sep 20, 2024
@shakuzen
Copy link
Member

Thanks for putting this on the radar explicitly. The intention has been to document this, but we wanted to make sure we got enough feedback about the change and could make the updated documentation as helpful based on common scenarios in which MeterFilter was used in ways contrary to what the change expects. I think it may be helpful to update something related to this in 1.12.x even if it may be a bit different wording compared to 1.13.x where the concrete change was made.

@shakuzen shakuzen modified the milestones: 1.12.x, 1.13.x Oct 1, 2024
@apollo13
Copy link

apollo13 commented Nov 7, 2024

Personally I think it would help to get called out loudly in the release notes (it is a breaking change after all) with a clear example on how a previous working MeterFilter would get replaced.

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

No branches or pull requests

3 participants