chore(v2): add example of setting store metrics #22819
Conversation
tac0turtle
requested review from
kocubinski,
julienrbrt and
a team
as code owners
📝 Walkthrough📝 WalkthroughWalkthroughThe changes introduced in this pull request include the addition of a no-operation metrics implementation in the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
store/v2/metrics/metrics.go (1)
49-58: Add interface compliance check and enhance documentationWhile the implementation is correct, consider these improvements:
- Add explicit interface compliance check
- Enhance documentation to explain when and why to use NoOpMetrics
+var _ StoreMetrics = NoOpMetrics{} + -// NoOpMetrics is a no-op implementation of the StoreMetrics interface +// NoOpMetrics provides a no-op implementation of StoreMetrics interface. +// It's useful when metrics collection is not required, avoiding the overhead +// of time.Now() calls and metrics collection. type NoOpMetrics struct{}
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (3)
simapp/v2/app_di.go(1 hunks)store/v2/metrics/metrics.go(1 hunks)store/v2/root/factory.go(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- simapp/v2/app_di.go
🧰 Additional context used
📓 Path-based instructions (2)
store/v2/metrics/metrics.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
store/v2/root/factory.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (2)
store/v2/metrics/metrics.go (1)
Line range hint 1-58: Implementation aligns well with PR objectives
The addition of NoOpMetrics provides a clean way to make metrics optional while maintaining interface compatibility. The implementation is correct and follows good Go practices.
store/v2/root/factory.go (1)
131-131: Consider making metrics configurable through Options
While replacing nil with NoOpMetrics{} is an improvement, consider making metrics configurable through the Options struct to provide more flexibility.
Let's verify the impact of this change:
Suggested improvement:
type Options struct {
SCType SCType `mapstructure:"sc-type"`
SCPruningOption *store.PruningOption `mapstructure:"sc-pruning-option"`
IavlConfig *iavl.Config `mapstructure:"iavl-config"`
+ Metrics metrics.StoreMetrics `mapstructure:"metrics"`
}
func DefaultStoreOptions() Options {
return Options{
SCType: SCTypeIavl,
SCPruningOption: &store.PruningOption{
KeepRecent: 2,
Interval: 100,
},
IavlConfig: &iavl.Config{
CacheSize: 100_000,
SkipFastStorageUpgrade: true,
},
+ Metrics: metrics.NoOpMetrics{},
}
}
Description
Closes: #22181
This pr adds an example of how to set metrics in storage.
Metrics are treated as a global, this is why there it not need a pass the metrics system to storage. I added a noop metric system in order to to help avoid accidental missing nil checks.
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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
Bug Fixes
Documentation