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

fix: avoid updating exemplar values during subsequent metric changes #620

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

psimk
Copy link
Contributor

@psimk psimk commented Mar 26, 2024

Problem

The current exemplars implementation expects that every time we update a metric, we will have fresh exemplar labels to set together with the metric. However, setups that have a low sampling rate for their exemplar labels (e.g. trace ids), this means that this implementation would be reseting exemplar labels.

This also creates a lot of noise in graphing solutions like Grafana as there are lots of exemplars displayed without any contextual data attached to them.

Solution

Before setting an exemplar, or even creating a brand new one, we first will check whether the the exemplar labels were configured with anything other that isn't the default empty object. If there are no exemplar labels, then we simply short circuit the function.

Note, this likely means that we could get rid off the defaultExemplarLabelSet field and just handle the undefined value, but I wanted to have the least amount of changes in the PR.

fixes #616


@SimenB

@SimenB
Copy link
Collaborator

SimenB commented Mar 26, 2024

Sweet, thanks! Gauge and Histograms are not affected?

@psimk
Copy link
Contributor Author

psimk commented Mar 26, 2024

Sweet, thanks! Gauge and Histograms are not affected?

Gauge's don't seem to have exemplars and I made the change for histograms in lib/histogram.js.

@SimenB
Copy link
Collaborator

SimenB commented Mar 26, 2024

👍

(I meant summary, but I see there's no exemplar support there either).

Could you add a changelog entry? (also, CI is failing)

@psimk psimk force-pushed the master branch 2 times, most recently from 4e514e7 to 823b163 Compare March 26, 2024 13:59
@psimk
Copy link
Contributor Author

psimk commented Mar 26, 2024

Could you add a changelog entry? (also, CI is failing)

Added.

Copy link
Collaborator

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

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.

Exemplar still gets updated(to one with empty labels) when providing no exemplar labels with the sample
2 participants