Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
github-actions
bot
added
the
Scope: Backend
taskbroker-client 0.1.8 added gauge as an abstract method on MetricsBackend. Implement it to match the existing pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit dd3bb67. Configure here.
| value: float, | ||
| instance: str | None = None, | ||
| tags: Tags | None = None, | ||
| sample_rate: float = 1, |
There was a problem hiding this comment.
Gauge bypasses global metrics sample rate setting
Low Severity
The new gauge method defaults sample_rate to 1, unlike incr, distribution, and timer which all default to None and fall back to settings.SENTRY_METRICS_SAMPLE_RATE. In deployments that override SENTRY_METRICS_SAMPLE_RATE to a value other than 1.0, gauge metrics will always be emitted at 100% while all other metric types respect the configured rate.
Reviewed by Cursor Bugbot for commit dd3bb67. Configure here.
There was a problem hiding this comment.
The method definition in taskbroker-client also has sample_rate defaulted to 1.
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| sentry_metrics.gauge( | ||
| key, | ||
| value, | ||
| instance=instance, |
There was a problem hiding this comment.
Bug: The gauge method's sample_rate defaults to 1, unlike other metrics methods which respect the global SENTRY_METRICS_SAMPLE_RATE setting.
Severity: MEDIUM
Suggested Fix
Change the signature of the gauge method to sample_rate: float | None = None. Inside the method, apply the global settings.SENTRY_METRICS_SAMPLE_RATE if sample_rate is None, mirroring the implementation of the incr, distribution, and timer methods in the same class.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: src/sentry/taskworker/adapters.py#L75
Potential issue: The `gauge` method in `SentryMetricsBackend` is defined with a default
`sample_rate` of `1`. This is inconsistent with other methods in the same class (`incr`,
`distribution`, `timer`), which accept `None` and then apply the global
`settings.SENTRY_METRICS_SAMPLE_RATE`. As a result, any calls to `gauge` from the
`taskbroker-client` library that do not explicitly provide a `sample_rate` will bypass
the global configuration and always sample at 100%. This could lead to an unexpected
increase in metric volume if a lower global sample rate is configured.
Did we get this right? 👍 / 👎 to inform future reviews.
|
There is another pull request #112629 which is also going to update the taskbroker-client library, we could go with that one as it contains other changes as well. |
|
Yes of course, I just wanted to make sure it's there! |
3 participants
Bumps
taskbroker-clientfrom 0.1.7 to 0.1.8 to pick up latest changes.