Revert "[CLOB-1014] [CLOB-1004] Unify metrics library, un-modularize … #967
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe codebase has undergone a metrics system overhaul, shifting from an in-house metrics package and Changes
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (7)
- protocol/lib/metrics/constants.go (1 hunks)
- protocol/lib/metrics/util.go (2 hunks)
- protocol/x/clob/abci.go (3 hunks)
- protocol/x/clob/keeper/deleveraging.go (8 hunks)
- protocol/x/clob/keeper/liquidations.go (6 hunks)
- protocol/x/clob/keeper/mev.go (9 hunks)
- protocol/x/clob/types/order_id.go (2 hunks)
Additional comments: 31
protocol/lib/metrics/util.go (2)
- 6-6: The import of the
timepackage is necessary for the new functionality introduced in theModuleMeasureSinceWithLabelsfunction.- 71-88: The new function
ModuleMeasureSinceWithLabelsis correctly defined and follows the established pattern of other functions in the file. It uses thegometrics.MeasureSinceWithLabelsfunction to emit a time measure metric, which is consistent with the metrics package's usage.protocol/x/clob/types/order_id.go (2)
- 9-9: The new import
github.com/armon/go-metricsis necessary due to the change in the return type of theGetOrderIdLabelsmethod from[]metrics.Labelto[]gometrics.Label.- 177-178: The change in the return type of the
GetOrderIdLabelsmethod from[]metrics.Labelto[]gometrics.Labelis consistent with the new import and the rest of the changes in the PR related to metrics handling.protocol/x/clob/abci.go (3)
- 7-7: The new import
github.com/armon/go-metricsis consistent with the changes in metrics handling throughout the PR.- 76-79: The replacement of the
metricspackage with thetelemetrypackage for incrementing counters is consistent with the PR's objective to revert changes to the metrics system.- 121-124: The use of
telemetry.SetGaugeWithLabelsto set the gauge for the insurance fund balance is consistent with the changes in metrics handling and the addition of theInsuranceFundBalanceconstant.protocol/lib/metrics/constants.go (1)
- 316-316: The addition of the
InsuranceFundBalanceconstant is consistent with the changes in theabci.gofile and the PR's objectives to update metrics handling.protocol/x/clob/keeper/deleveraging.go (7)
- 9-14: The import changes are consistent with the PR's objective to revert the metrics handling.
- 81-87: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [84-96]
The labels are correctly updated to use
gometrics.Labeland theIncrCounterWithLabelsfunction is replaced withgometrics.SetGaugeWithLabels, which aligns with the PR objectives.
- 103-111: The
telemetry.IncrCounterWithLabelsandgometrics.AddSampleWithLabelsfunctions are used appropriately to record metrics, consistent with the PR's goal.- 120-123: The
gometrics.AddSampleWithLabelsfunction is used correctly to record the percent filled of the deleveraging operation.- 291-295: The
telemetry.ModuleMeasureSincefunction is replaced withdeferto ensure the metric is recorded after the function execution, which is a good practice for timing metrics.- 431-453: The
gometrics.AddSampleWithLabelsfunction is used correctly to record various metrics related to the deleveraging process.- 587-595: The
gometrics.AddSampleWithLabelsfunction is used correctly to record the stat quantums deleveraged in quote quantums.protocol/x/clob/keeper/mev.go (9)
- 9-10: The import changes reflect the switch from
armon/go-metricstocosmos/cosmos-sdk/telemetry, which is consistent with the PR's objective to revert the metrics handling.- 73-73: The
deferstatement has been updated to use thetelemetrypackage for metric recording, aligning with the revert of the metrics system.- 112-112: The error handling within the
RecordMevMetricsfunction now correctly uses thetelemetrypackage to increment the error counter.- 124-124: The error counter incrementation after failing to calculate PnL for block proposer MEV matches has been updated to use the
telemetrypackage.- 138-138: The error handling for creating MEV matches for validator operations has been updated to use the
telemetrypackage for incrementing the error counter.- 150-150: The error handling for calculating match PnL for the validator has been updated to use the
telemetrypackage for incrementing the error counter.- 223-223: The error counter incrementation after failing to get the consensus round has been updated to use the
telemetrypackage.- 235-235: The error handling for failing to get the proposer by consensus address now correctly uses the
telemetrypackage to increment the error counter.- 290-302: The gauge setting for MEV metrics has been updated to use the
telemetrypackage, which is consistent with the changes made throughout the file.protocol/x/clob/keeper/liquidations.go (7)
- 13-13: The import alias
gometricsforgithub.com/armon/go-metricsis correctly defined.- 45-50: The change from
metrics.AddSampletogometrics.AddSamplewith the updated metric names and labels is correct and aligns with the PR objectives.- 285-285: The update from
metrics.Labeltogometrics.Labelis consistent with the changes made throughout the file.- 299-302: The replacement of
metrics.AddSampleWithLabelswithgometrics.AddSampleWithLabelsand the adjustment of the metric names and labels are correct.- 325-328: The switch from
metrics.IncrCounterWithLabelstotelemetry.IncrCounterWithLabelswith the updated metric names and labels is consistent with the PR objectives.- 330-333: The change from
metrics.AddSampleWithLabelstogometrics.AddSampleWithLabelsfor the distribution metric is correct.- 593-605: The update from
metrics.IncrCounterWithLabelstotelemetry.IncrCounterWithLabelswith the new labels is consistent with the changes made in other parts of the file.
Comment on lines
+56
to
+60
| telemetry.IncrCounter( | ||
| 1, | ||
| types.ModuleName, | ||
| metrics.PrepareCheckState, | ||
| metrics.CannotDeleverageSubaccount, |
There was a problem hiding this comment.
The telemetry.IncrCounter function is being used, but according to the PR summary, the usage of cosmos/cosmos-sdk/telemetry should be replaced with armon/go-metrics. This instance was not updated.
- telemetry.IncrCounter(
+ gometrics.SetGaugeWithLabels(Committable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| telemetry.IncrCounter( | |
| 1, | |
| types.ModuleName, | |
| metrics.PrepareCheckState, | |
| metrics.CannotDeleverageSubaccount, | |
| gometrics.SetGaugeWithLabels( | |
| 1, | |
| types.ModuleName, | |
| metrics.PrepareCheckState, | |
| metrics.CannotDeleverageSubaccount, |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (2)
protocol/go.modis excluded by:!**/*.modprotocol/go.sumis excluded by:!**/*.sum
Files selected for processing (1)
- protocol/lib/metrics/lib.go (1 hunks)
Additional comments: 1
protocol/lib/metrics/lib.go (1)
- 69-71: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [1-48]
The removal of
ModuleMeasureSinceWithLabelsaligns with the PR's objective to revert changes related to metrics handling. The existing functions provide similar functionality and the TODO comments suggest future improvements for custom calculations.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (5)
- protocol/x/clob/abci.go (3 hunks)
- protocol/x/clob/keeper/deleveraging.go (8 hunks)
- protocol/x/clob/keeper/liquidations.go (6 hunks)
- protocol/x/clob/keeper/mev.go (10 hunks)
- protocol/x/clob/types/order_id.go (2 hunks)
Files skipped from review as they are similar to previous changes (5)
- protocol/x/clob/abci.go
- protocol/x/clob/keeper/deleveraging.go
- protocol/x/clob/keeper/liquidations.go
- protocol/x/clob/keeper/mev.go
- protocol/x/clob/types/order_id.go
lucas-dydx
approved these changes
Jan 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Metrics are not showing up due to commit
9e08e81/ pr #792 . Revert.EDIT: this was not the issue.