Merge pull request #2865 from input-output-hk/djo/2855/aggregator/better-signer-signature-metrics

Alenar · web-flow · commit ecad03d76d63 · 2025-12-17T11:50:17.000+01:00
feat: add "total successful" metrics for signature and signer registrations
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-aggregator/Cargo.toml b/mithril-aggregator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.8.1"
+version = "0.8.2"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }
diff --git a/mithril-aggregator/src/http_server/routes/signatures_routes.rs b/mithril-aggregator/src/http_server/routes/signatures_routes.rs
@@ -112,8 +112,18 @@ mod handlers {
                     Ok(reply::server_error(err))
                 }
             },
-            Ok(SignatureRegistrationStatus::Registered) => Ok(reply::empty(StatusCode::CREATED)),
-            Ok(SignatureRegistrationStatus::Buffered) => Ok(reply::empty(StatusCode::ACCEPTED)),
+            Ok(registration_status) => {
+                metrics_service
+                    .get_signature_registration_total_successful_since_startup()
+                    .increment(&[METRICS_HTTP_ORIGIN]);
+
+                match registration_status {
+                    SignatureRegistrationStatus::Registered => {
+                        Ok(reply::empty(StatusCode::CREATED))
+                    }
+                    SignatureRegistrationStatus::Buffered => Ok(reply::empty(StatusCode::ACCEPTED)),
+                }
+            }
         }
     }
 }
@@ -127,6 +137,7 @@ mod tests {
     use warp::test::request;
 
     use mithril_api_spec::APISpec;
+    use mithril_common::test::mock_extensions::MockBuilder;
     use mithril_common::{
         entities::SignedEntityType, messages::RegisterSignatureMessageHttp, test::double::Dummy,
     };
@@ -150,15 +161,28 @@ mod tests {
     }
 
     #[tokio::test]
-    async fn test_register_signatures_increments_signature_registration_total_received_since_startup_metric()
+    async fn test_register_signatures_increments_signature_registration_total_received_and_successful_since_startup_metric_if_successful()
      {
         let method = Method::POST.as_str();
         let path = "/register-signatures";
-        let dependency_manager = Arc::new(initialize_dependencies!().await);
-        let initial_counter_value = dependency_manager
+        let dependency_manager = {
+            let mut deps = initialize_dependencies!().await;
+            deps.certifier_service = MockBuilder::<MockCertifierService>::configure(|mock| {
+                mock.expect_register_single_signature()
+                    .returning(|_, _| Ok(SignatureRegistrationStatus::Registered));
+            });
+            deps.single_signer_authenticator =
+                Arc::new(SingleSignatureAuthenticator::new_that_authenticate_everything());
+            Arc::new(deps)
+        };
+        let initial_received_counter_value = dependency_manager
             .metrics_service
             .get_signature_registration_total_received_since_startup()
             .get(&["HTTP"]);
+        let initial_successful_counter_value = dependency_manager
+            .metrics_service
+            .get_signature_registration_total_successful_since_startup()
+            .get(&["HTTP"]);
 
         request()
             .method(method)
@@ -170,12 +194,65 @@ mod tests {
             .await;
 
         assert_eq!(
-            initial_counter_value + 1,
+            initial_received_counter_value + 1,
             dependency_manager
                 .metrics_service
                 .get_signature_registration_total_received_since_startup()
                 .get(&["HTTP"])
         );
+        assert_eq!(
+            initial_successful_counter_value + 1,
+            dependency_manager
+                .metrics_service
+                .get_signature_registration_total_successful_since_startup()
+                .get(&["HTTP"])
+        );
+    }
+
+    #[tokio::test]
+    async fn test_register_signatures_only_increments_signature_registration_total_received_since_startup_metric_if_failure()
+     {
+        let method = Method::POST.as_str();
+        let path = "/register-signatures";
+        let dependency_manager = {
+            let mut deps = initialize_dependencies!().await;
+            deps.single_signer_authenticator =
+                Arc::new(SingleSignatureAuthenticator::new_that_reject_everything());
+            Arc::new(deps)
+        };
+
+        let initial_received_counter_value = dependency_manager
+            .metrics_service
+            .get_signature_registration_total_received_since_startup()
+            .get(&["HTTP"]);
+        let initial_successful_counter_value = dependency_manager
+            .metrics_service
+            .get_signature_registration_total_successful_since_startup()
+            .get(&["HTTP"]);
+
+        request()
+            .method(method)
+            .path(path)
+            .json(&RegisterSignatureMessageHttp::dummy())
+            .reply(&setup_router(RouterState::new_with_dummy_config(
+                dependency_manager.clone(),
+            )))
+            .await;
+
+        assert_eq!(
+            initial_received_counter_value + 1,
+            dependency_manager
+                .metrics_service
+                .get_signature_registration_total_received_since_startup()
+                .get(&["HTTP"])
+        );
+        assert_eq!(
+            initial_successful_counter_value,
+            dependency_manager
+                .metrics_service
+                .get_signature_registration_total_successful_since_startup()
+                .get(&["HTTP"])
+        );
     }
 
     #[tokio::test]
diff --git a/mithril-aggregator/src/http_server/routes/signer_routes.rs b/mithril-aggregator/src/http_server/routes/signer_routes.rs
@@ -139,6 +139,10 @@ mod handlers {
                     epoch_str.as_str(),
                 ));
 
+                metrics_service
+                    .get_signer_registration_total_successful_since_startup()
+                    .increment(&[origin_tag.as_deref().unwrap_or_default()]);
+
                 Ok(reply::empty(StatusCode::CREATED))
             }
             Err(SignerRegistrationError::ExistingSigner(signer_with_stake)) => {
@@ -271,6 +275,7 @@ mod tests {
         test::{
             builder::MithrilFixtureBuilder,
             double::{Dummy, fake_data},
+            mock_extensions::MockBuilder,
         },
     };
 
@@ -334,15 +339,77 @@ mod tests {
     }
 
     #[tokio::test]
-    async fn test_register_signer_post_increments_signer_registration_total_received_since_startup_metric()
+    async fn test_register_signer_increments_signer_registration_total_received_and_successful_since_startup_metric_if_successful()
+     {
+        let method = Method::POST.as_str();
+        let path = "/register-signer";
+        let dependency_manager = {
+            let mut deps = initialize_dependencies!().await;
+            deps.signer_registerer = MockBuilder::<MockSignerRegisterer>::configure(|mock| {
+                mock.expect_register_signer()
+                    .returning(|_, _| Ok(fake_data::signers_with_stakes(1).pop().unwrap()));
+            });
+            Arc::new(deps)
+        };
+
+        let initial_received_counter_value = dependency_manager
+            .metrics_service
+            .get_signer_registration_total_received_since_startup()
+            .get(&["TEST"]);
+        let initial_successful_counter_value = dependency_manager
+            .metrics_service
+            .get_signer_registration_total_successful_since_startup()
+            .get(&["HTTP"]);
+
+        request()
+            .method(method)
+            .path(path)
+            .json(&RegisterSignerMessage::dummy())
+            .header(MITHRIL_ORIGIN_TAG_HEADER, "TEST")
+            .reply(&setup_router(RouterState::new_with_origin_tag_white_list(
+                dependency_manager.clone(),
+                &["TEST"],
+            )))
+            .await;
+
+        assert_eq!(
+            initial_received_counter_value + 1,
+            dependency_manager
+                .metrics_service
+                .get_signer_registration_total_received_since_startup()
+                .get(&["TEST"])
+        );
+        assert_eq!(
+            initial_successful_counter_value + 1,
+            dependency_manager
+                .metrics_service
+                .get_signer_registration_total_successful_since_startup()
+                .get(&["TEST"])
+        );
+    }
+
+    #[tokio::test]
+    async fn test_register_signer_only_increments_signer_registration_total_received_since_startup_metric_if_failure()
      {
         let method = Method::POST.as_str();
         let path = "/register-signer";
-        let dependency_manager = Arc::new(initialize_dependencies!().await);
-        let initial_counter_value = dependency_manager
+        let dependency_manager = {
+            let mut deps = initialize_dependencies!().await;
+            deps.signer_registerer = MockBuilder::<MockSignerRegisterer>::configure(|mock| {
+                mock.expect_register_signer()
+                    .returning(|_, _| Err(SignerRegistrationError::RegistrationRoundNotYetOpened));
+            });
+            Arc::new(deps)
+        };
+
+        let initial_received_counter_value = dependency_manager
             .metrics_service
             .get_signer_registration_total_received_since_startup()
             .get(&["TEST"]);
+        let initial_successful_counter_value = dependency_manager
+            .metrics_service
+            .get_signer_registration_total_successful_since_startup()
+            .get(&["HTTP"]);
 
         request()
             .method(method)
@@ -356,12 +423,19 @@ mod tests {
             .await;
 
         assert_eq!(
-            initial_counter_value + 1,
+            initial_received_counter_value + 1,
             dependency_manager
                 .metrics_service
                 .get_signer_registration_total_received_since_startup()
                 .get(&["TEST"])
         );
+        assert_eq!(
+            initial_successful_counter_value,
+            dependency_manager
+                .metrics_service
+                .get_signer_registration_total_successful_since_startup()
+                .get(&["TEST"])
+        );
     }
 
     #[tokio::test]
diff --git a/mithril-aggregator/src/metrics/service.rs b/mithril-aggregator/src/metrics/service.rs
@@ -84,11 +84,21 @@ build_metrics_service!(
         "Number of signer registrations received since startup on a Mithril aggregator node",
         &[SIGNER_REGISTRATION_ORIGIN_TAG_LABEL]
     ),
+    signer_registration_total_successful_since_startup:MetricCounterWithLabels(
+        "mithril_aggregator_signer_registration_total_successful_since_startup",
+        "Number of successful signer registrations received since startup on a Mithril aggregator node",
+        &[SIGNER_REGISTRATION_ORIGIN_TAG_LABEL]
+    ),
     signature_registration_total_received_since_startup:MetricCounterWithLabels(
         "mithril_aggregator_signature_registration_total_received_since_startup",
         "Number of signature registrations received since startup on a Mithril aggregator node",
         &[SIGNER_SIGNATURE_ORIGIN_TAG_LABEL]
     ),
+    signature_registration_total_successful_since_startup:MetricCounterWithLabels(
+        "mithril_aggregator_signature_registration_total_successful_since_startup",
+        "Number of successful signature registrations received since startup on a Mithril aggregator node",
+        &[SIGNER_SIGNATURE_ORIGIN_TAG_LABEL]
+    ),
     certificate_total_produced_since_startup:MetricCounter(
         "mithril_aggregator_certificate_total_produced_since_startup",
         "Number of certificates produced since startup on a Mithril aggregator node"
diff --git a/mithril-aggregator/src/services/signature_processor.rs b/mithril-aggregator/src/services/signature_processor.rs
