chore: add structured logging params (#77)

Author: danyalprout

.env.example

@@ -8,6 +8,7 @@ TIPS_INGRESS_KAFKA_INGRESS_TOPIC=tips-ingress
 TIPS_INGRESS_KAFKA_AUDIT_PROPERTIES_FILE=/app/docker/ingress-audit-kafka-properties
 TIPS_INGRESS_KAFKA_AUDIT_TOPIC=tips-audit
 TIPS_INGRESS_LOG_LEVEL=info
+TIPS_INGRESS_LOG_FORMAT=pretty
 TIPS_INGRESS_SEND_TRANSACTION_DEFAULT_LIFETIME_SECONDS=10800
 TIPS_INGRESS_RPC_SIMULATION=http://localhost:8549
 TIPS_INGRESS_METRICS_ADDR=0.0.0.0:9002
@@ -20,6 +21,7 @@ TIPS_INGRESS_BUILDER_RPCS=http://localhost:2222,http://localhost:2222,http://loc
 TIPS_AUDIT_KAFKA_PROPERTIES_FILE=/app/docker/audit-kafka-properties
 TIPS_AUDIT_KAFKA_TOPIC=tips-audit
 TIPS_AUDIT_LOG_LEVEL=info
+TIPS_AUDIT_LOG_FORMAT=pretty
 TIPS_AUDIT_S3_BUCKET=tips
 TIPS_AUDIT_S3_CONFIG_TYPE=manual
 TIPS_AUDIT_S3_ENDPOINT=http://localhost:7000

Cargo.lock

@@ -12,7 +12,6 @@ resolver = "2"
 
 [workspace.dependencies]
 tips-audit = { path = "crates/audit" }
-tips-bundle-pool = { path = "crates/bundle-pool" }
 tips-core = { path = "crates/core" }
 
 # Reth
@@ -37,7 +36,7 @@ op-alloy-flz = {  version = "0.13.1" }
 
 tokio = { version = "1.47.1", features = ["full"] }
 tracing = "0.1.41"
-tracing-subscriber = { version = "0.3.20", features = ["env-filter"] }
+tracing-subscriber = { version = "0.3.20", features = ["env-filter", "json"] }
 anyhow = "1.0.99"
 clap = { version = "4.5.47", features = ["derive", "env"] }
 url = "2.5.7"

Cargo.toml

@@ -7,7 +7,7 @@ use rdkafka::consumer::Consumer;
 use tips_audit::{
     KafkaAuditArchiver, KafkaAuditLogReader, S3EventReaderWriter, create_kafka_consumer,
 };
-use tips_core::logger::init_logger;
+use tips_core::logger::init_logger_with_format;
 use tracing::info;
 
 #[derive(Debug, Clone, ValueEnum)]
@@ -31,6 +31,9 @@ struct Args {
     #[arg(long, env = "TIPS_AUDIT_LOG_LEVEL", default_value = "info")]
     log_level: String,
 
+    #[arg(long, env = "TIPS_AUDIT_LOG_FORMAT", default_value = "pretty")]
+    log_format: tips_core::logger::LogFormat,
+
     #[arg(long, env = "TIPS_AUDIT_S3_CONFIG_TYPE", default_value = "aws")]
     s3_config_type: S3ConfigType,
 
@@ -53,7 +56,7 @@ async fn main() -> Result<()> {
 
     let args = Args::parse();
 
-    init_logger(&args.log_level);
+    init_logger_with_format(&args.log_level, args.log_format);
 
     info!(
         kafka_properties_file = %args.kafka_properties_file,

crates/audit/src/bin/main.rs

@@ -1,7 +1,35 @@
+use std::str::FromStr;
 use tracing::warn;
-use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
+use tracing_subscriber::{fmt, layer::SubscriberExt, util::SubscriberInitExt};
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum LogFormat {
+    Pretty,
+    Json,
+    Compact,
+}
+
+impl FromStr for LogFormat {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.to_lowercase().as_str() {
+            "json" => Ok(LogFormat::Json),
+            "compact" => Ok(LogFormat::Compact),
+            "pretty" => Ok(LogFormat::Pretty),
+            _ => {
+                warn!("Invalid log format '{}', defaulting to 'pretty'", s);
+                Ok(LogFormat::Pretty)
+            }
+        }
+    }
+}
 
 pub fn init_logger(log_level: &str) {
+    init_logger_with_format(log_level, LogFormat::Pretty);
+}
+
+pub fn init_logger_with_format(log_level: &str, format: LogFormat) {
     let level = match log_level.to_lowercase().as_str() {
         "trace" => tracing::Level::TRACE,
         "debug" => tracing::Level::DEBUG,
@@ -14,11 +42,32 @@ pub fn init_logger(log_level: &str) {
         }
     };
 
-    tracing_subscriber::registry()
-        .with(
-            tracing_subscriber::EnvFilter::try_from_default_env()
-                .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new(level.to_string())),
-        )
-        .with(tracing_subscriber::fmt::layer())
-        .init();
+    let env_filter = tracing_subscriber::EnvFilter::try_from_default_env()
+        .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new(level.to_string()));
+
+    match format {
+        LogFormat::Json => {
+            tracing_subscriber::registry()
+                .with(env_filter)
+                .with(
+                    fmt::layer()
+                        .json()
+                        .flatten_event(true)
+                        .with_current_span(true),
+                )
+                .init();
+        }
+        LogFormat::Compact => {
+            tracing_subscriber::registry()
+                .with(env_filter)
+                .with(fmt::layer().compact())
+                .init();
+        }
+        LogFormat::Pretty => {
+            tracing_subscriber::registry()
+                .with(env_filter)
+                .with(fmt::layer().pretty())
+                .init();
+        }
+    }
 }

crates/core/src/logger.rs

@@ -7,7 +7,7 @@ use rdkafka::producer::FutureProducer;
 use tips_audit::{BundleEvent, KafkaBundleEventPublisher, connect_audit_to_publisher};
 use tips_core::MeterBundleResponse;
 use tips_core::kafka::load_kafka_config_from_file;
-use tips_core::logger::init_logger;
+use tips_core::logger::init_logger_with_format;
 use tips_ingress_rpc::Config;
 use tips_ingress_rpc::connect_ingress_to_builder;
 use tips_ingress_rpc::metrics::init_prometheus_exporter;
@@ -24,7 +24,7 @@ async fn main() -> anyhow::Result<()> {
     // clone once instead of cloning each field before passing to `IngressService::new`
     let cfg = config.clone();
 
-    init_logger(&config.log_level);
+    init_logger_with_format(&config.log_level, config.log_format);
 
     init_prometheus_exporter(config.metrics_addr).expect("Failed to install Prometheus exporter");
 

crates/ingress-rpc/src/bin/main.rs

@@ -86,6 +86,9 @@ pub struct Config {
     #[arg(long, env = "TIPS_INGRESS_LOG_LEVEL", default_value = "info")]
     pub log_level: String,
 
+    #[arg(long, env = "TIPS_INGRESS_LOG_FORMAT", default_value = "pretty")]
+    pub log_format: tips_core::logger::LogFormat,
+
     /// Default lifetime for sent transactions in seconds (default: 3 hours)
     #[arg(
         long,