blockifier: clean the cache metric api (#10379)

Author: ArniStarkware

crates/apollo_batcher/src/metrics.rs

@@ -78,7 +78,7 @@ pub(crate) fn record_block_close_reason(reason: BlockCloseReason) {
 }
 
 pub const BATCHER_CLASS_CACHE_METRICS: CacheMetrics =
-    CacheMetrics { misses: CLASS_CACHE_MISSES, hits: CLASS_CACHE_HITS };
+    CacheMetrics::new(CLASS_CACHE_MISSES, CLASS_CACHE_HITS);
 
 pub fn register_metrics(storage_height: BlockNumber) {
     STORAGE_HEIGHT.register();

crates/apollo_dashboard/src/panels/blockifier.rs

@@ -38,8 +38,8 @@ fn get_panel_blockifier_state_reader_class_cache_miss_ratio(
     Panel::ratio_time_series(
         name.as_str(),
         description.as_str(),
-        &class_cache_metrics.misses,
-        &[&class_cache_metrics.misses, &class_cache_metrics.hits],
+        class_cache_metrics.misses(),
+        &[class_cache_metrics.misses(), class_cache_metrics.hits()],
         BLOCKIFIER_METRIC_RATE_DURATION,
     )
 }
@@ -54,7 +54,7 @@ fn get_panel_blockifier_state_reader_native_class_returned_ratio() -> Panel {
         name,
         description,
         &NATIVE_CLASS_RETURNED,
-        &[&class_cache_metrics.misses, &class_cache_metrics.hits],
+        &[class_cache_metrics.misses(), class_cache_metrics.hits()],
         BLOCKIFIER_METRIC_RATE_DURATION,
     )
 }

crates/apollo_gateway/src/metrics.rs

@@ -247,7 +247,7 @@ impl Drop for GatewayMetricHandle {
 }
 
 pub const GATEWAY_CLASS_CACHE_METRICS: CacheMetrics =
-    CacheMetrics { misses: CLASS_CACHE_MISSES, hits: CLASS_CACHE_HITS };
+    CacheMetrics::new(CLASS_CACHE_MISSES, CLASS_CACHE_HITS);
 
 pub(crate) fn register_metrics() {
     GATEWAY_CLASS_CACHE_METRICS.register();

crates/blockifier/src/metrics.rs

@@ -29,10 +29,23 @@ define_metrics!(
 
 pub const BLOCKIFIER_METRIC_RATE_DURATION: &str = "5m";
 
-// TODO(Arni): Fix visibility of members of this struct (make them not public).
 pub struct CacheMetrics {
-    pub misses: MetricCounter,
-    pub hits: MetricCounter,
+    misses: MetricCounter,
+    hits: MetricCounter,
+}
+
+impl CacheMetrics {
+    pub const fn new(misses: MetricCounter, hits: MetricCounter) -> Self {
+        Self { misses, hits }
+    }
+
+    pub fn misses(&self) -> &MetricCounter {
+        &self.misses
+    }
+
+    pub fn hits(&self) -> &MetricCounter {
+        &self.hits
+    }
 }
 
 impl CacheMetrics {
@@ -55,6 +68,7 @@ impl CacheMetrics {
             self.hits.get_scope(),
             "Scope of misses and hits must be the same"
         );
+
         self.misses.get_scope()
     }
 }

crates/blockifier/src/test_utils/initial_test_state.rs

@@ -22,20 +22,20 @@ use crate::test_utils::contracts::FeatureContractData;
 use crate::test_utils::dict_state_reader::DictStateReader;
 
 /// Placeholder class cache metrics. The metrics are not tested in the blockifier's context.
-const BLOCKIFIER_CLASS_CACHE_METRICS: CacheMetrics = CacheMetrics {
-    misses: MetricCounter::new(
+const BLOCKIFIER_CLASS_CACHE_METRICS: CacheMetrics = CacheMetrics::new(
+    MetricCounter::new(
         MetricScope::Blockifier,
         "Class Cache Misses in Blockifier",
         "Counter of the number of times that the class cache was missed",
         0,
     ),
-    hits: MetricCounter::new(
+    MetricCounter::new(
         MetricScope::Blockifier,
         "Class Cache Misses in Blockifier",
         "Counter of the number of times that the class cache was hit",
         0,
     ),
-};
+);
 
 /// Utility to fund an account.
 pub fn fund_account(

crates/native_blockifier/src/py_block_executor.rs

@@ -55,20 +55,20 @@ pub type ApolloStateReaderAndContractManager = StateReaderAndContractManager<Apo
 const RESULT_SERIALIZE_ERR: &str = "Failed serializing execution info.";
 
 /// Placeholder class cache metrics. There are not metrics on the native blockifier.
-const NATIVE_BLOCKIFIER_CLASS_CACHE_METRICS: CacheMetrics = CacheMetrics {
-    misses: MetricCounter::new(
+const NATIVE_BLOCKIFIER_CLASS_CACHE_METRICS: CacheMetrics = CacheMetrics::new(
+    MetricCounter::new(
         MetricScope::Blockifier,
         "Class Cache Misses in Native Blockifier",
         "Counter of the number of times that the class cache was missed",
         0,
     ),
-    hits: MetricCounter::new(
+    MetricCounter::new(
         MetricScope::Blockifier,
         "Class Cache Misses in Native Blockifier",
         "Counter of the number of times that the class cache was hit",
         0,
     ),
-};
+);
 
 /// Return type for the finalize method containing state diffs, bouncer weights, and CASM hash
 /// computation data.