Add WRITE_RATE_LIMIT_STEP_BYTES_WRITTEN for WriteRateLimitStep (#96)

aptos-labs · Jan 21, 2025 · f2dc006 · f2dc006
1 parent a56b641
commit f2dc006
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/aptos-indexer-processors-sdk/sdk/src/common_steps/write_rate_limit_step.rs b/aptos-indexer-processors-sdk/sdk/src/common_steps/write_rate_limit_step.rs
@@ -3,7 +3,10 @@ use crate::{
     types::transaction_context::TransactionContext,
     utils::{
         errors::ProcessorError,
-        step_metrics::{StepMetricLabels, WRITE_RATE_LIMIT_STEP_REMAINING_BYTES},
+        step_metrics::{
+            StepMetricLabels, WRITE_RATE_LIMIT_STEP_BYTES_WRITTEN,
+            WRITE_RATE_LIMIT_STEP_REMAINING_BYTES,
+        },
     },
 };
 use serde::{Deserialize, Serialize};
@@ -134,6 +137,13 @@ where
             })
             .set(self.current_bucket_size as i64);
 
+        // Bump the inverse metric, which is just the bytes written as a counter.
+        WRITE_RATE_LIMIT_STEP_BYTES_WRITTEN
+            .get_or_create(&StepMetricLabels {
+                step_name: self.name(),
+            })
+            .inc_by(size_of_item as u64);
+
         Ok(out)
     }
 }

diff --git a/aptos-indexer-processors-sdk/sdk/src/utils/step_metrics.rs b/aptos-indexer-processors-sdk/sdk/src/utils/step_metrics.rs
@@ -108,6 +108,12 @@ pub fn init_step_metrics_registry(registry: &mut Registry) {
         "WriteRateLimitStep remaining bytes (aka tokens) that can be written this instant",
         WRITE_RATE_LIMIT_STEP_REMAINING_BYTES.clone(),
     );
+
+    registry.register(
+        format!("{}_{}", METRICS_PREFIX, "write_rate_limit_bytes_written"),
+        "WriteRateLimitStep bytes written",
+        WRITE_RATE_LIMIT_STEP_BYTES_WRITTEN.clone(),
+    );
 }
 
 #[derive(Clone, Debug, Hash, PartialEq, Eq, EncodeLabelSet)]
@@ -165,6 +171,9 @@ pub static POLLING_ERROR_COUNT: Lazy<Family<StepMetricLabels, Counter>> =
 pub static WRITE_RATE_LIMIT_STEP_REMAINING_BYTES: Lazy<Family<StepMetricLabels, Gauge>> =
     Lazy::new(Family::<StepMetricLabels, Gauge>::default);
 
+pub static WRITE_RATE_LIMIT_STEP_BYTES_WRITTEN: Lazy<Family<StepMetricLabels, Counter>> =
+    Lazy::new(Family::<StepMetricLabels, Counter>::default);
+
 #[derive(Builder)]
 pub struct StepMetrics {
     pub labels: StepMetricLabels,