feat: Remove metrics crate (#1902)

## What ❔ Remove emitting metrics with metrics crate - emit them with vise instead ## Why ❔ To be consistent with libraries we use ## Checklist   - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [x] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zk fmt` and `zk lint`. - [x] Spellcheck has been run via `zk spellcheck`.
matter-labs · May 14, 2024 · 5f7bda7 · 5f7bda7
1 parent a4e099f
commit 5f7bda7
Show file tree

Hide file tree

Showing 23 changed files with 257 additions and 135 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/core/bin/contract-verifier/Cargo.toml b/core/bin/contract-verifier/Cargo.toml
@@ -29,7 +29,7 @@ thiserror.workspace = true
 chrono.workspace = true
 serde_json.workspace = true
 ethabi.workspace = true
-metrics.workspace = true
+vise.workspace = true
 hex.workspace = true
 serde = { workspace = true, features = ["derive"] }
 structopt.workspace = true

diff --git a/core/bin/contract-verifier/src/main.rs b/core/bin/contract-verifier/src/main.rs
@@ -16,6 +16,7 @@ use zksync_utils::wait_for_tasks::ManagedTasks;
 use crate::verifier::ContractVerifier;
 
 pub mod error;
+mod metrics;
 pub mod verifier;
 pub mod zksolc_utils;
 pub mod zkvyper_utils;

diff --git a/core/bin/contract-verifier/src/metrics.rs b/core/bin/contract-verifier/src/metrics.rs
@@ -0,0 +1,14 @@
+use std::time::Duration;
+
+use vise::{Buckets, Histogram, Metrics};
+
+#[derive(Debug, Metrics)]
+#[metrics(prefix = "api_contract_verifier")]
+pub(crate) struct ApiContractVerifierMetrics {
+    #[metrics(buckets = Buckets::LATENCIES)]
+    pub request_processing_time: Histogram<Duration>,
+}
+
+#[vise::register]
+pub(crate) static API_CONTRACT_VERIFIER_METRICS: vise::Global<ApiContractVerifierMetrics> =
+    vise::Global::new();
diff --git a/core/bin/contract-verifier/src/verifier.rs b/core/bin/contract-verifier/src/verifier.rs
@@ -25,6 +25,7 @@ use zksync_types::{
 
 use crate::{
     error::ContractVerifierError,
+    metrics::API_CONTRACT_VERIFIER_METRICS,
     zksolc_utils::{Optimizer, Settings, Source, StandardJson, ZkSolc, ZkSolcInput, ZkSolcOutput},
     zkvyper_utils::{ZkVyper, ZkVyperInput},
 };
@@ -523,10 +524,9 @@ impl JobProcessor for ContractVerifier {
             let verification_result = Self::verify(&mut connection, job, config).await;
             Self::process_result(&mut connection, job_id, verification_result).await;
 
-            metrics::histogram!(
-                "api.contract_verifier.request_processing_time",
-                started_at.elapsed()
-            );
+            API_CONTRACT_VERIFIER_METRICS
+                .request_processing_time
+                .observe(started_at.elapsed());
             Ok(())
         })
     }

diff --git a/core/lib/zksync_core/Cargo.toml b/core/lib/zksync_core/Cargo.toml
@@ -67,7 +67,6 @@ serde = { workspace = true, features = ["derive"] }
 serde_json.workspace = true
 serde_yaml.workspace = true
 itertools.workspace = true
-metrics.workspace = true
 ctrlc.workspace = true
 rand.workspace = true
 

diff --git a/core/node/house_keeper/Cargo.toml b/core/node/house_keeper/Cargo.toml
@@ -21,4 +21,3 @@ async-trait.workspace = true
 tokio = { workspace = true, features = ["time"] }
 anyhow.workspace = true
 tracing.workspace = true
-metrics.workspace = true
diff --git a/core/node/house_keeper/src/fri_proof_compressor_job_retry_manager.rs b/core/node/house_keeper/src/fri_proof_compressor_job_retry_manager.rs
@@ -4,7 +4,7 @@ use async_trait::async_trait;
 use prover_dal::{Prover, ProverDal};
 use zksync_dal::ConnectionPool;
 
-use crate::periodic_job::PeriodicJob;
+use crate::{metrics::PROVER_FRI_METRICS, periodic_job::PeriodicJob};
 
 #[derive(Debug)]
 pub struct FriProofCompressorJobRetryManager {
@@ -48,7 +48,9 @@ impl PeriodicJob for FriProofCompressorJobRetryManager {
         for stuck_job in stuck_jobs {
             tracing::info!("re-queuing fri proof compressor job {:?}", stuck_job);
         }
-        metrics::counter!("prover_fri.proof_compressor.requeued_jobs", job_len as u64);
+        PROVER_FRI_METRICS
+            .proof_compressor_requeued_jobs
+            .inc_by(job_len as u64);
         Ok(())
     }
 

diff --git a/core/node/house_keeper/src/fri_proof_compressor_queue_monitor.rs b/core/node/house_keeper/src/fri_proof_compressor_queue_monitor.rs
@@ -3,9 +3,10 @@ use prover_dal::{Prover, ProverDal};
 use zksync_dal::ConnectionPool;
 use zksync_types::prover_dal::JobCountStatistics;
 
-use crate::periodic_job::PeriodicJob;
-
-const PROOF_COMPRESSOR_SERVICE_NAME: &str = "proof_compressor";
+use crate::{
+    metrics::{JobStatus, PROVER_FRI_METRICS},
+    periodic_job::PeriodicJob,
+};
 
 #[derive(Debug)]
 pub struct FriProofCompressorStatsReporter {
@@ -48,17 +49,9 @@ impl PeriodicJob for FriProofCompressorStatsReporter {
             );
         }
 
-        metrics::gauge!(
-            format!("prover_fri.{}.jobs", PROOF_COMPRESSOR_SERVICE_NAME),
-            stats.queued as f64,
-            "type" => "queued"
-        );
-
-        metrics::gauge!(
-            format!("prover_fri.{}.jobs", PROOF_COMPRESSOR_SERVICE_NAME),
-            stats.in_progress as f64,
-            "type" => "in_progress"
-        );
+        PROVER_FRI_METRICS.proof_compressor_jobs[&JobStatus::Queued].set(stats.queued as u64);
+        PROVER_FRI_METRICS.proof_compressor_jobs[&JobStatus::InProgress]
+            .set(stats.in_progress as u64);
 
         let oldest_not_compressed_batch = self
             .pool
@@ -70,13 +63,9 @@ impl PeriodicJob for FriProofCompressorStatsReporter {
             .await;
 
         if let Some(l1_batch_number) = oldest_not_compressed_batch {
-            metrics::gauge!(
-                format!(
-                    "prover_fri.{}.oldest_not_compressed_batch",
-                    PROOF_COMPRESSOR_SERVICE_NAME
-                ),
-                l1_batch_number.0 as f64
-            );
+            PROVER_FRI_METRICS
+                .proof_compressor_oldest_uncompressed_batch
+                .set(l1_batch_number.0 as u64);
         }
 
         Ok(())

diff --git a/core/node/house_keeper/src/fri_prover_job_retry_manager.rs b/core/node/house_keeper/src/fri_prover_job_retry_manager.rs
@@ -4,7 +4,7 @@ use async_trait::async_trait;
 use prover_dal::{Prover, ProverDal};
 use zksync_dal::ConnectionPool;
 
-use crate::periodic_job::PeriodicJob;
+use crate::{metrics::SERVER_METRICS, periodic_job::PeriodicJob};
 
 #[derive(Debug)]
 pub struct FriProverJobRetryManager {
@@ -48,7 +48,9 @@ impl PeriodicJob for FriProverJobRetryManager {
         for stuck_job in stuck_jobs {
             tracing::info!("re-queuing fri prover job {:?}", stuck_job);
         }
-        metrics::counter!("server.prover_fri.requeued_jobs", job_len as u64);
+        SERVER_METRICS
+            .prover_fri_requeued_jobs
+            .inc_by(job_len as u64);
         Ok(())
     }
 

diff --git a/core/node/house_keeper/src/fri_prover_queue_monitor.rs b/core/node/house_keeper/src/fri_prover_queue_monitor.rs
@@ -3,7 +3,7 @@ use prover_dal::{Prover, ProverDal};
 use zksync_config::configs::fri_prover_group::FriProverGroupConfig;
 use zksync_dal::{ConnectionPool, Core, CoreDal};
 
-use crate::periodic_job::PeriodicJob;
+use crate::{metrics::FRI_PROVER_METRICS, periodic_job::PeriodicJob};
 
 #[derive(Debug)]
 pub struct FriProverStatsReporter {
@@ -57,22 +57,19 @@ impl PeriodicJob for FriProverStatsReporter {
                 .get_group_id_for_circuit_id_and_aggregation_round(circuit_id, aggregation_round)
                 .unwrap_or(u8::MAX);
 
-            metrics::gauge!(
-              "fri_prover.prover.jobs",
-              stats.queued as f64,
-              "type" => "queued",
-              "circuit_id" => circuit_id.to_string(),
-              "aggregation_round" => aggregation_round.to_string(),
-              "prover_group_id" => group_id.to_string(),
+            FRI_PROVER_METRICS.report_prover_jobs(
+                "queued",
+                circuit_id,
+                aggregation_round,
+                group_id,
+                stats.queued as u64,
             );
-
-            metrics::gauge!(
-              "fri_prover.prover.jobs",
-              stats.in_progress as f64,
-              "type" => "in_progress",
-              "circuit_id" => circuit_id.to_string(),
-              "aggregation_round" => aggregation_round.to_string(),
-              "prover_group_id" => group_id.to_string(),
+            FRI_PROVER_METRICS.report_prover_jobs(
+                "in_progress",
+                circuit_id,
+                aggregation_round,
+                group_id,
+                stats.in_progress as u64,
             );
         }
 
@@ -82,10 +79,9 @@ impl PeriodicJob for FriProverStatsReporter {
             .await;
 
         for ((circuit_id, aggregation_round), l1_batch_number) in lag_by_circuit_type {
-            metrics::gauge!(
-              "fri_prover.block_number", l1_batch_number.0 as f64,
-              "circuit_id" => circuit_id.to_string(),
-              "aggregation_round" => aggregation_round.to_string());
+            FRI_PROVER_METRICS.block_number
+                [&(circuit_id.to_string(), aggregation_round.to_string())]
+                .set(l1_batch_number.0 as u64);
         }
 
         // FIXME: refactor metrics here
@@ -97,7 +93,7 @@ impl PeriodicJob for FriProverStatsReporter {
             .get_oldest_unpicked_batch()
             .await
         {
-            Some(l1_batch_number) => l1_batch_number.0 as f64,
+            Some(l1_batch_number) => l1_batch_number.0 as u64,
             // if there is no unpicked batch in database, we use sealed batch number as a result
             None => {
                 db_conn
@@ -106,20 +102,21 @@ impl PeriodicJob for FriProverStatsReporter {
                     .await
                     .unwrap()
                     .unwrap()
-                    .0 as f64
+                    .0 as u64
             }
         };
-        metrics::gauge!("fri_prover.oldest_unpicked_batch", oldest_unpicked_batch);
+        FRI_PROVER_METRICS
+            .oldest_unpicked_batch
+            .set(oldest_unpicked_batch);
 
         if let Some(l1_batch_number) = db_conn
             .proof_generation_dal()
             .get_oldest_not_generated_batch()
             .await
         {
-            metrics::gauge!(
-                "fri_prover.oldest_not_generated_batch",
-                l1_batch_number.0 as f64
-            )
+            FRI_PROVER_METRICS
+                .oldest_not_generated_batch
+                .set(l1_batch_number.0 as u64);
         }
 
         for aggregation_round in 0..3 {
@@ -128,11 +125,9 @@ impl PeriodicJob for FriProverStatsReporter {
                 .min_unproved_l1_batch_number_for_aggregation_round(aggregation_round.into())
                 .await
             {
-                metrics::gauge!(
-                    "fri_prover.oldest_unprocessed_block_by_round",
-                    l1_batch_number.0 as f64,
-                    "aggregation_round" => aggregation_round.to_string()
-                )
+                FRI_PROVER_METRICS.oldest_unprocessed_block_by_round
+                    [&aggregation_round.to_string()]
+                    .set(l1_batch_number.0 as u64);
             }
         }
 

diff --git a/core/node/house_keeper/src/fri_witness_generator_jobs_retry_manager.rs b/core/node/house_keeper/src/fri_witness_generator_jobs_retry_manager.rs
@@ -4,7 +4,10 @@ use zksync_config::configs::fri_witness_generator::WitnessGenerationTimeouts;
 use zksync_dal::ConnectionPool;
 use zksync_types::prover_dal::StuckJobs;
 
-use crate::periodic_job::PeriodicJob;
+use crate::{
+    metrics::{WitnessType, SERVER_METRICS},
+    periodic_job::PeriodicJob,
+};
 
 #[derive(Debug)]
 pub struct FriWitnessGeneratorJobRetryManager {
@@ -33,10 +36,8 @@ impl FriWitnessGeneratorJobRetryManager {
         for stuck_job in stuck_jobs {
             tracing::info!("re-queuing {:?} {:?}", witness_type, stuck_job);
         }
-        metrics::counter!(
-            format!("server.{:?}.requeued_jobs", witness_type),
-            stuck_jobs.len() as u64
-        );
+        SERVER_METRICS.requeued_jobs[&WitnessType::from(witness_type)]
+            .inc_by(stuck_jobs.len() as u64);
     }
 
     pub async fn requeue_stuck_witness_inputs_jobs(&mut self) {