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

refactor: remove global metrics in store #14439

Merged
merged 8 commits into from
Dec 30, 2022
Merged

Conversation

tac0turtle
Copy link
Member

Description

this pr is a first attempt at removing the global telemetry variable from usage in store.

Changes:

  • Store defines its own telemetry interface
  • MeasureSince does not take a time.Now() in order to allow application developers to set a NoOp metric gather for reduced allocation of time.Now().
  • Adds metrics to the creation of a store.

@alexanderbez @julienrbrt would like to hear from you if this is a direction I should continue, I didnt complete it to not spend too much time headed in a direction where I shouldn't.


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

// MeasureSince provides a wrapper functionality for emitting a a time measure
// metric with global labels (if any).
func (m Metrics) MeasureSince(keys ...string) {
start := time.Now()

Check warning

Code scanning / CodeQL

Calling the system time

Calling the system time may be a possible source of non-determinism
@tac0turtle tac0turtle marked this pull request as ready for review December 29, 2022 10:29
@tac0turtle tac0turtle requested a review from a team as a code owner December 29, 2022 10:29
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm. although if we need to extract telemetry again, I still think a package would make sense.

@tac0turtle
Copy link
Member Author

we need to refactor how telemetry works in the sdk to spin it out. Right now it works like a global, which is fine for modules but we should define a telemetry interface as well.

@sonarcloud
Copy link

sonarcloud bot commented Dec 30, 2022

[Cosmos SDK] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 3 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tac0turtle tac0turtle merged commit f3dd510 into main Dec 30, 2022
@tac0turtle tac0turtle deleted the marko/remove_globalmetrics branch December 30, 2022 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants