feat: Check telemetry enabled state before emitting metrics #19857
Conversation
|
Important Auto Review SkippedDraft detected. Please check the settings in the CodeRabbit UI or the To trigger a single review, invoke the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
github-actions
bot
added
C:x/staking
C:x/gov
C:x/slashing
C:x/distribution
lucaslopezf
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| // Now return the current time if telemetry is enabled or a zero time if it's not | ||
| func Now(ctx sdk.Context) time.Time { | ||
| if ctx.TelemetryEnabled() { | ||
| return time.Now() |
Check warning
Code scanning / CodeQL
Calling the system time
| telemetry.IncrCounter(1, "query", "count") | ||
| telemetry.IncrCounter(1, "query", req.Path) | ||
| defer telemetry.MeasureSince(time.Now(), req.Path) | ||
| defer telemetry.MeasureSince(sdk.Context{}, time.Now(), req.Path) |
There was a problem hiding this comment.
If this approach is used, it is necessary to consider how to handle this case.
There was a problem hiding this comment.
Also, you CANNOT put time.Now() in the defer clause. The time.Now() must be called and put into a variable separately. Otherwise, you're not measuring anything. E.g. https://github.com/cosmos/cosmos-sdk/blob/main/store/root/store.go#L275-L278
There was a problem hiding this comment.
Thanks for the comment! This PR is part of this comment I made on this issue: #10245
| } | ||
|
|
||
| // Now return the current time if telemetry is enabled or a zero time if it's not | ||
| func Now(ctx sdk.Context) time.Time { |
There was a problem hiding this comment.
as a heads up we want to avoid using sdk.Context anywhere
There was a problem hiding this comment.
Perfect! This PR is part of this comment I made on this issue: #10245
Description
Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...