refactor(aggregator): general log function for http server route calls

There is a caveat: payload and query strings can't be logs this way, so
in this cas a local "function enter" log is done.
This ensure that those data are logged at the price of routes producing
two logs for one call.

Author: Alenar

mithril-aggregator/src/http_server/routes/artifact_routes/cardano_stake_distribution.rs

@@ -52,7 +52,7 @@ pub mod handlers {
     use crate::services::MessageService;
 
     use mithril_common::entities::Epoch;
-    use slog::{debug, warn, Logger};
+    use slog::{warn, Logger};
     use std::convert::Infallible;
     use std::sync::Arc;
     use warp::http::StatusCode;
@@ -64,8 +64,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /artifact/cardano-stake-distributions");
-
         match http_message_service
             .get_cardano_stake_distribution_list_message(LIST_MAX_ITEMS)
             .await
@@ -84,11 +82,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(
-            logger,
-            "GET /artifact/cardano-stake-distribution/{signed_entity_id}"
-        );
-
         match http_message_service
             .get_cardano_stake_distribution_message(&signed_entity_id)
             .await
@@ -111,11 +104,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(
-            logger,
-            "GET /artifact/cardano-stake-distributions/epoch/{epoch}"
-        );
-
         let artifact_epoch = match epoch.parse::<u64>() {
             Ok(epoch) => Epoch(epoch),
             Err(err) => {

mithril-aggregator/src/http_server/routes/artifact_routes/cardano_transaction.rs

@@ -35,7 +35,7 @@ pub mod handlers {
     use crate::http_server::routes::reply;
     use crate::services::MessageService;
 
-    use slog::{debug, warn, Logger};
+    use slog::{warn, Logger};
     use std::convert::Infallible;
     use std::sync::Arc;
     use warp::http::StatusCode;
@@ -47,8 +47,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /artifact/cardano-transactions");
-
         match http_message_service
             .get_cardano_transaction_list_message(LIST_MAX_ITEMS)
             .await
@@ -68,11 +66,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(
-            logger,
-            "GET /artifact/cardano-transaction/{signed_entity_id}"
-        );
-
         match http_message_service
             .get_cardano_transaction_message(&signed_entity_id)
             .await

mithril-aggregator/src/http_server/routes/artifact_routes/mithril_stake_distribution.rs

@@ -36,7 +36,7 @@ pub mod handlers {
     use crate::http_server::routes::reply;
     use crate::services::MessageService;
 
-    use slog::{debug, warn, Logger};
+    use slog::{warn, Logger};
     use std::convert::Infallible;
     use std::sync::Arc;
     use warp::http::StatusCode;
@@ -48,8 +48,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /artifact/mithril-stake-distributions");
-
         match http_message_service
             .get_mithril_stake_distribution_list_message(LIST_MAX_ITEMS)
             .await
@@ -68,11 +66,6 @@ pub mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(
-            logger,
-            "GET /artifact/mithril-stake-distribution/{signed_entity_id}"
-        );
-
         match http_message_service
             .get_mithril_stake_distribution_message(&signed_entity_id)
             .await

mithril-aggregator/src/http_server/routes/artifact_routes/snapshot.rs

@@ -109,8 +109,6 @@ mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /artifact/snapshots");
-
         match http_message_service
             .get_snapshot_list_message(LIST_MAX_ITEMS)
             .await
@@ -129,7 +127,6 @@ mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /artifact/snapshot/{signed_entity_id}");
         match http_message_service
             .get_snapshot_message(&signed_entity_id)
             .await
@@ -188,8 +185,6 @@ mod handlers {
         config: Configuration,
         signed_entity_service: Arc<dyn SignedEntityService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /snapshot_download/snapshot/{digest}");
-
         match signed_entity_service
             .get_signed_snapshot_by_id(&digest)
             .await

mithril-aggregator/src/http_server/routes/certificate_routes.rs

@@ -51,7 +51,7 @@ mod handlers {
         ToCertificatePendingMessageAdapter,
     };
 
-    use slog::{debug, warn, Logger};
+    use slog::{warn, Logger};
     use std::convert::Infallible;
     use std::sync::Arc;
     use warp::http::StatusCode;
@@ -63,8 +63,6 @@ mod handlers {
         logger: Logger,
         certificate_pending_store: Arc<CertificatePendingStore>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /certificate-pending");
-
         match certificate_pending_store.get().await {
             Ok(Some(certificate_pending)) => Ok(reply::json(
                 &ToCertificatePendingMessageAdapter::adapt(certificate_pending),
@@ -83,8 +81,6 @@ mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /certificates");
-
         match http_message_service
             .get_certificate_list_message(LIST_MAX_ITEMS)
             .await
@@ -103,8 +99,6 @@ mod handlers {
         logger: Logger,
         http_message_service: Arc<dyn MessageService>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /certificate/{certificate_hash}");
-
         match http_message_service
             .get_certificate_message(&certificate_hash)
             .await

mithril-aggregator/src/http_server/routes/epoch_routes.rs

@@ -69,7 +69,7 @@ async fn get_epoch_settings_message(
 }
 
 mod handlers {
-    use slog::{debug, Logger};
+    use slog::{warn, Logger};
     use std::collections::BTreeSet;
     use std::convert::Infallible;
     use warp::http::StatusCode;
@@ -86,13 +86,15 @@ mod handlers {
         epoch_service: EpochServiceWrapper,
         allowed_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /epoch-settings");
         let epoch_settings_message =
             get_epoch_settings_message(epoch_service, allowed_discriminants).await;
 
         match epoch_settings_message {
             Ok(message) => Ok(reply::json(&message, StatusCode::OK)),
-            Err(err) => Ok(reply::server_error(err)),
+            Err(err) => {
+                warn!(logger,"epoch_settings::error"; "error" => ?err);
+                Ok(reply::server_error(err))
+            }
         }
     }
 }

mithril-aggregator/src/http_server/routes/middlewares.rs

@@ -1,4 +1,4 @@
-use slog::Logger;
+use slog::{debug, Logger};
 use std::collections::BTreeSet;
 use std::convert::Infallible;
 use std::sync::Arc;
@@ -25,6 +25,24 @@ pub(crate) fn with_logger(
     warp::any().map(move || logger.clone())
 }
 
+/// Log to apply each time a route is called
+///
+/// Example of log produced: `POST /aggregator/register-signatures 202 Accepted`
+pub(crate) fn log_route_call(
+    dependency_manager: &DependencyContainer,
+) -> warp::log::Log<impl Fn(warp::log::Info<'_>) + Clone> {
+    let logger = http_server_child_logger(&dependency_manager.root_logger);
+    warp::log::custom(move |info| {
+        debug!(
+            logger,
+            "{} {} {}",
+            info.method(),
+            info.path(),
+            info.status()
+        )
+    })
+}
+
 /// With certificate pending store
 pub(crate) fn with_certificate_pending_store(
     dependency_manager: &DependencyContainer,

mithril-aggregator/src/http_server/routes/proof_routes.rs

@@ -73,9 +73,8 @@ mod handlers {
     ) -> Result<impl warp::Reply, Infallible> {
         let transaction_hashes = transaction_parameters.split_transactions_hashes();
         debug!(
-            logger,
-            "GET /proof/cardano-transaction?transaction_hashes={}",
-            transaction_parameters.transaction_hashes
+            logger, ">> proof_cardano_transaction";
+            "transaction_hashes" => &transaction_parameters.transaction_hashes
         );
 
         if let Err(error) = validator.validate(&transaction_hashes) {

mithril-aggregator/src/http_server/routes/root_routes.rs

@@ -27,7 +27,7 @@ mod handlers {
     use std::collections::BTreeSet;
     use std::{convert::Infallible, sync::Arc};
 
-    use slog::{debug, Logger};
+    use slog::Logger;
     use warp::http::StatusCode;
 
     use mithril_common::api_version::APIVersionProvider;
@@ -46,8 +46,6 @@ mod handlers {
         allowed_signed_entity_type_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
         configuration: Configuration,
     ) -> Result<impl warp::Reply, Infallible> {
-        debug!(logger, "GET /");
-
         let open_api_version = unwrap_to_internal_server_error!(
             api_version_provider.compute_current_version(),
             logger => "root::error"

mithril-aggregator/src/http_server/routes/router.rs

@@ -74,6 +74,7 @@ pub fn routes(
                     .to_string(),
             )
         })
+        .with(middlewares::log_route_call(&dependency_manager))
 }
 
 /// API Version verification