Skip to content

Commit 0d4d6bc

Browse files
AlenarAlenar
authored
Merge pull request #2009 from input-output-hk/djo/1981/rework-aggregator-log-msgs
Rework & harmonize aggregator log messages
2 parents 8fbaaee + 20156b9 commit 0d4d6bc

39 files changed

+397
-318
lines changed

‎Cargo.lock

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎mithril-aggregator/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mithril-aggregator"
3-
version = "0.5.82"
3+
version = "0.5.83"
44
description = "A Mithril Aggregator server"
55
authors = { workspace = true }
66
edition = { workspace = true }

‎mithril-aggregator/src/artifact_builder/cardano_immutable_files_full.rs

+6-15
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,7 @@ impl CardanoImmutableFilesFullArtifactBuilder {
6060
beacon: &CardanoDbBeacon,
6161
snapshot_digest: &str,
6262
) -> StdResult<OngoingSnapshot> {
63-
debug!(
64-
self.logger,
65-
"CardanoImmutableFilesFullArtifactBuilder: create snapshot archive"
66-
);
63+
debug!(self.logger, ">> create_snapshot_archive");
6764

6865
let snapshotter = self.snapshotter.clone();
6966
let snapshot_name = format!(
@@ -81,7 +78,7 @@ impl CardanoImmutableFilesFullArtifactBuilder {
8178
})
8279
.await??;
8380

84-
debug!(self.logger, " > snapshot created: '{ongoing_snapshot:?}'");
81+
debug!(self.logger, " > Snapshot created: '{ongoing_snapshot:?}'");
8582

8683
Ok(ongoing_snapshot)
8784
}
@@ -90,19 +87,16 @@ impl CardanoImmutableFilesFullArtifactBuilder {
9087
&self,
9188
ongoing_snapshot: &OngoingSnapshot,
9289
) -> StdResult<Vec<SnapshotLocation>> {
93-
debug!(
94-
self.logger,
95-
"CardanoImmutableFilesFullArtifactBuilder: upload snapshot archive"
96-
);
90+
debug!(self.logger, ">> upload_snapshot_archive");
9791
let location = self
9892
.snapshot_uploader
9993
.upload_snapshot(ongoing_snapshot.get_file_path())
10094
.await;
10195

10296
if let Err(error) = tokio::fs::remove_file(ongoing_snapshot.get_file_path()).await {
10397
warn!(
104-
self.logger,
105-
" > Post upload ongoing snapshot file removal failure: {error}"
98+
self.logger, " > Post upload ongoing snapshot file removal failure";
99+
"error" => error
106100
);
107101
}
108102

@@ -116,10 +110,7 @@ impl CardanoImmutableFilesFullArtifactBuilder {
116110
snapshot_digest: String,
117111
remote_locations: Vec<String>,
118112
) -> StdResult<Snapshot> {
119-
debug!(
120-
self.logger,
121-
"CardanoImmutableFilesFullArtifactBuilder: create snapshot"
122-
);
113+
debug!(self.logger, ">> create_snapshot");
123114

124115
let snapshot = Snapshot::new(
125116
snapshot_digest,

‎mithril-aggregator/src/commands/serve_command.rs

+4-5
Original file line numberDiff line numberDiff line change
@@ -177,10 +177,9 @@ impl ServeCommand {
177177
}
178178
Err(error) => {
179179
warn!(
180-
root_logger,
181-
"Failed to build the `SignersImporter`:\n url to import `{}`\n Error: {:?}",
182-
cexplorer_pools_url,
183-
error
180+
root_logger, "Failed to build the `SignersImporter`";
181+
"url_to_import" => cexplorer_pools_url,
182+
"error" => ?error
184183
);
185184
}
186185
}
@@ -190,7 +189,7 @@ impl ServeCommand {
190189
dependencies_builder.vanish().await;
191190

192191
if let Err(e) = join_set.join_next().await.unwrap()? {
193-
crit!(root_logger, "A critical error occurred: {e}");
192+
crit!(root_logger, "A critical error occurred"; "error" => e);
194193
}
195194

196195
// stop servers

‎mithril-aggregator/src/dependency_injection/builder.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,8 @@ impl DependenciesBuilder {
599599
let epoch_settings_configuration = self.get_epoch_settings_configuration()?;
600600
debug!(
601601
logger,
602-
"Handle discrepancies at startup of epoch settings store, will record epoch settings from the configuration for epoch {current_epoch}: {epoch_settings_configuration:?}"
602+
"Handle discrepancies at startup of epoch settings store, will record epoch settings from the configuration for epoch {current_epoch}";
603+
"epoch_settings_configuration" => ?epoch_settings_configuration,
603604
);
604605
epoch_settings_store
605606
.handle_discrepancies_at_startup(current_epoch, &epoch_settings_configuration)

‎mithril-aggregator/src/event_store/runner.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ impl EventStore {
3737
let persister = EventPersister::new(connection);
3838
info!(
3939
self.logger,
40-
"monitoring: starting event loop to log messages."
40+
"Starting monitoring event loop to log messages."
4141
);
4242
loop {
4343
if let Some(message) = self.receiver.recv().await {
44-
debug!(self.logger, "Event received: {message:?}");
44+
debug!(self.logger, "Event received"; "event" => ?message);
4545
let event = persister
4646
.persist(message)
4747
.with_context(|| "event persist failure")?;
48-
debug!(self.logger, "event ID={} created", event.event_id);
48+
debug!(self.logger, "Event ID={} created", event.event_id);
4949
} else {
5050
info!(self.logger, "No more events to proceed, quitting…");
5151
break;

‎mithril-aggregator/src/event_store/transmitter_service.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ impl TransmitterService<EventMessage> {
5252
{
5353
let content = serde_json::to_string(content).map_err(|e| {
5454
let error_msg = format!("Serialization error while forging event message: {e}");
55-
warn!(self.logger, "Event message error => «{error_msg}»");
55+
warn!(self.logger, "Event message error"; "error" => &error_msg);
5656

5757
error_msg
5858
})?;
@@ -68,7 +68,7 @@ impl TransmitterService<EventMessage> {
6868
self.get_transmitter().send(message.clone()).map_err(|e| {
6969
let error_msg =
7070
format!("An error occurred when sending message {message:?} to monitoring: '{e}'.");
71-
warn!(self.logger, "Event message error => «{error_msg}»");
71+
warn!(self.logger, "Event message error"; "error" => &error_msg);
7272

7373
error_msg
7474
})

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

+2-8
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ pub mod handlers {
5252
use crate::services::MessageService;
5353

5454
use mithril_common::entities::Epoch;
55-
use slog::{debug, warn, Logger};
55+
use slog::{warn, Logger};
5656
use std::convert::Infallible;
5757
use std::sync::Arc;
5858
use warp::http::StatusCode;
@@ -64,15 +64,13 @@ pub mod handlers {
6464
logger: Logger,
6565
http_message_service: Arc<dyn MessageService>,
6666
) -> Result<impl warp::Reply, Infallible> {
67-
debug!(logger, "⇄ HTTP SERVER: artifacts");
68-
6967
match http_message_service
7068
.get_cardano_stake_distribution_list_message(LIST_MAX_ITEMS)
7169
.await
7270
{
7371
Ok(message) => Ok(reply::json(&message, StatusCode::OK)),
7472
Err(err) => {
75-
warn!(logger, "list_artifacts_cardano_stake_distribution"; "error" => ?err);
73+
warn!(logger, "get_cardano_stake_distribution_list::error"; "error" => ?err);
7674
Ok(reply::server_error(err))
7775
}
7876
}
@@ -84,8 +82,6 @@ pub mod handlers {
8482
logger: Logger,
8583
http_message_service: Arc<dyn MessageService>,
8684
) -> Result<impl warp::Reply, Infallible> {
87-
debug!(logger, "⇄ HTTP SERVER: artifact/{signed_entity_id}");
88-
8985
match http_message_service
9086
.get_cardano_stake_distribution_message(&signed_entity_id)
9187
.await
@@ -108,8 +104,6 @@ pub mod handlers {
108104
logger: Logger,
109105
http_message_service: Arc<dyn MessageService>,
110106
) -> Result<impl warp::Reply, Infallible> {
111-
debug!(logger, "⇄ HTTP SERVER: artifact/epoch/{epoch}");
112-
113107
let artifact_epoch = match epoch.parse::<u64>() {
114108
Ok(epoch) => Epoch(epoch),
115109
Err(err) => {

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

+1-5
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ pub mod handlers {
3535
use crate::http_server::routes::reply;
3636
use crate::services::MessageService;
3737

38-
use slog::{debug, warn, Logger};
38+
use slog::{warn, Logger};
3939
use std::convert::Infallible;
4040
use std::sync::Arc;
4141
use warp::http::StatusCode;
@@ -47,8 +47,6 @@ pub mod handlers {
4747
logger: Logger,
4848
http_message_service: Arc<dyn MessageService>,
4949
) -> Result<impl warp::Reply, Infallible> {
50-
debug!(logger, "⇄ HTTP SERVER: artifacts");
51-
5250
match http_message_service
5351
.get_cardano_transaction_list_message(LIST_MAX_ITEMS)
5452
.await
@@ -68,8 +66,6 @@ pub mod handlers {
6866
logger: Logger,
6967
http_message_service: Arc<dyn MessageService>,
7068
) -> Result<impl warp::Reply, Infallible> {
71-
debug!(logger, "⇄ HTTP SERVER: artifact/{signed_entity_id}");
72-
7369
match http_message_service
7470
.get_cardano_transaction_message(&signed_entity_id)
7571
.await

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

+1-5
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ pub mod handlers {
3636
use crate::http_server::routes::reply;
3737
use crate::services::MessageService;
3838

39-
use slog::{debug, warn, Logger};
39+
use slog::{warn, Logger};
4040
use std::convert::Infallible;
4141
use std::sync::Arc;
4242
use warp::http::StatusCode;
@@ -48,8 +48,6 @@ pub mod handlers {
4848
logger: Logger,
4949
http_message_service: Arc<dyn MessageService>,
5050
) -> Result<impl warp::Reply, Infallible> {
51-
debug!(logger, "⇄ HTTP SERVER: artifacts");
52-
5351
match http_message_service
5452
.get_mithril_stake_distribution_list_message(LIST_MAX_ITEMS)
5553
.await
@@ -68,8 +66,6 @@ pub mod handlers {
6866
logger: Logger,
6967
http_message_service: Arc<dyn MessageService>,
7068
) -> Result<impl warp::Reply, Infallible> {
71-
debug!(logger, "⇄ HTTP SERVER: artifact/{signed_entity_id}");
72-
7369
match http_message_service
7470
.get_mithril_stake_distribution_message(&signed_entity_id)
7571
.await

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

+1-6
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,6 @@ mod handlers {
109109
logger: Logger,
110110
http_message_service: Arc<dyn MessageService>,
111111
) -> Result<impl warp::Reply, Infallible> {
112-
debug!(logger, "⇄ HTTP SERVER: artifacts");
113-
114112
match http_message_service
115113
.get_snapshot_list_message(LIST_MAX_ITEMS)
116114
.await
@@ -129,7 +127,6 @@ mod handlers {
129127
logger: Logger,
130128
http_message_service: Arc<dyn MessageService>,
131129
) -> Result<impl warp::Reply, Infallible> {
132-
debug!(logger, "⇄ HTTP SERVER: artifact/{signed_entity_id}");
133130
match http_message_service
134131
.get_snapshot_message(&signed_entity_id)
135132
.await
@@ -155,7 +152,7 @@ mod handlers {
155152
let filepath = reply.path().to_path_buf();
156153
debug!(
157154
logger,
158-
"⇄ HTTP SERVER: ensure_downloaded_file_is_a_snapshot / file: `{}`",
155+
">> ensure_downloaded_file_is_a_snapshot / file: `{}`",
159156
filepath.display()
160157
);
161158

@@ -188,8 +185,6 @@ mod handlers {
188185
config: Configuration,
189186
signed_entity_service: Arc<dyn SignedEntityService>,
190187
) -> Result<impl warp::Reply, Infallible> {
191-
debug!(logger, "⇄ HTTP SERVER: snapshot_download/{}", digest);
192-
193188
match signed_entity_service
194189
.get_signed_snapshot_by_id(&digest)
195190
.await

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

+1-10
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ mod handlers {
5151
ToCertificatePendingMessageAdapter,
5252
};
5353

54-
use slog::{debug, warn, Logger};
54+
use slog::{warn, Logger};
5555
use std::convert::Infallible;
5656
use std::sync::Arc;
5757
use warp::http::StatusCode;
@@ -63,8 +63,6 @@ mod handlers {
6363
logger: Logger,
6464
certificate_pending_store: Arc<CertificatePendingStore>,
6565
) -> Result<impl warp::Reply, Infallible> {
66-
debug!(logger, "⇄ HTTP SERVER: certificate_pending");
67-
6866
match certificate_pending_store.get().await {
6967
Ok(Some(certificate_pending)) => Ok(reply::json(
7068
&ToCertificatePendingMessageAdapter::adapt(certificate_pending),
@@ -83,8 +81,6 @@ mod handlers {
8381
logger: Logger,
8482
http_message_service: Arc<dyn MessageService>,
8583
) -> Result<impl warp::Reply, Infallible> {
86-
debug!(logger, "⇄ HTTP SERVER: certificate_certificates",);
87-
8884
match http_message_service
8985
.get_certificate_list_message(LIST_MAX_ITEMS)
9086
.await
@@ -103,11 +99,6 @@ mod handlers {
10399
logger: Logger,
104100
http_message_service: Arc<dyn MessageService>,
105101
) -> Result<impl warp::Reply, Infallible> {
106-
debug!(
107-
logger,
108-
"⇄ HTTP SERVER: certificate_certificate_hash/{}", certificate_hash
109-
);
110-
111102
match http_message_service
112103
.get_certificate_message(&certificate_hash)
113104
.await

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

+5-3
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ async fn get_epoch_settings_message(
6969
}
7070

7171
mod handlers {
72-
use slog::{debug, Logger};
72+
use slog::{warn, Logger};
7373
use std::collections::BTreeSet;
7474
use std::convert::Infallible;
7575
use warp::http::StatusCode;
@@ -86,13 +86,15 @@ mod handlers {
8686
epoch_service: EpochServiceWrapper,
8787
allowed_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
8888
) -> Result<impl warp::Reply, Infallible> {
89-
debug!(logger, "⇄ HTTP SERVER: epoch_settings");
9089
let epoch_settings_message =
9190
get_epoch_settings_message(epoch_service, allowed_discriminants).await;
9291

9392
match epoch_settings_message {
9493
Ok(message) => Ok(reply::json(&message, StatusCode::OK)),
95-
Err(err) => Ok(reply::server_error(err)),
94+
Err(err) => {
95+
warn!(logger,"epoch_settings::error"; "error" => ?err);
96+
Ok(reply::server_error(err))
97+
}
9698
}
9799
}
98100
}

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

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use slog::Logger;
1+
use slog::{debug, Logger};
22
use std::collections::BTreeSet;
33
use std::convert::Infallible;
44
use std::sync::Arc;
@@ -25,6 +25,24 @@ pub(crate) fn with_logger(
2525
warp::any().map(move || logger.clone())
2626
}
2727

28+
/// Log to apply each time a route is called
29+
///
30+
/// Example of log produced: `POST /aggregator/register-signatures 202 Accepted`
31+
pub(crate) fn log_route_call(
32+
dependency_manager: &DependencyContainer,
33+
) -> warp::log::Log<impl Fn(warp::log::Info<'_>) + Clone> {
34+
let logger = http_server_child_logger(&dependency_manager.root_logger);
35+
warp::log::custom(move |info| {
36+
debug!(
37+
logger,
38+
"{} {} {}",
39+
info.method(),
40+
info.path(),
41+
info.status()
42+
)
43+
})
44+
}
45+
2846
/// With certificate pending store
2947
pub(crate) fn with_certificate_pending_store(
3048
dependency_manager: &DependencyContainer,

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,8 @@ mod handlers {
7373
) -> Result<impl warp::Reply, Infallible> {
7474
let transaction_hashes = transaction_parameters.split_transactions_hashes();
7575
debug!(
76-
logger,
77-
"⇄ HTTP SERVER: proof_cardano_transaction?transaction_hashes={}",
78-
transaction_parameters.transaction_hashes
76+
logger, ">> proof_cardano_transaction";
77+
"transaction_hashes" => &transaction_parameters.transaction_hashes
7978
);
8079

8180
if let Err(error) = validator.validate(&transaction_hashes) {

0 commit comments

Comments
 (0)