chore(bridge-withdrawer): accumulating counter instead of guage for settled value #1814
Conversation
This file contains 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
…for total settled metric
Fraser999
reviewed
Nov 19, 2024
| @@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
|
|
|||
| ## [Unreleased] | |||
|
|
|||
| ### Added | |||
|
|
|||
| - New `accumulateded_settled_value` metric which tracks total settled since startup [#1814](https://github.com/astriaorg/astria/pull/1814) | |||
There was a problem hiding this comment.
Suggested change
| - New `accumulateded_settled_value` metric which tracks total settled since startup [#1814](https://github.com/astriaorg/astria/pull/1814) | |
| - New `accumulated_settled_value` metric which tracks total settled since startup [#1814](https://github.com/astriaorg/astria/pull/1814) |
| BATCH_TOTAL_SETTLED_VALUE, | ||
| "Total value of withdrawals settled in a given sequencer block", | ||
| ACCUMULATED_SETTLED_VALUE, | ||
| "Total value of withdrawals settled over time from batches", |
There was a problem hiding this comment.
Would be good to include the units used here. Also maybe worth replacing _VALUE in the metric name with the units too (or appending it to the name)
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.
Summary
Replaces the guage metric
batch_total_settled_valuewith the counter metricaccumulated_settled_valueBackground
The guage metric was not useful because we were not capturing the guage at each packet time, it was most likely going to always be zero. Instead replace with a counter which we can run a rate on to see the total amount of flow out. Because this is strictly increasing we aren't subject to different outputs with different scraping intervals.
Changes
batch_total_settled_valueand replace withaccumulated_settled_valueTesting
How are these changes tested?
Changelogs
Changelogs updated
Metrics
batch_total_settled_valueaccumulated_settled_valuemetricBreaking Changelist
This is technically speaking a breaking change on the metric interface, however the existing metric never worked, so I wouldn't consider truly breaking.