feat: Add version log

.dockerignore

@@ -1,2 +1 @@
-.git
 **/target/

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `PROVIDER_HTTP_ENDPOINT` to advance-runner config
 - Added `cartesi/rollups-node` docker image with all node binaries
 - Added completion status to GraphQL API
+- Added rollups-node version to the logs in all services
 
 ### Changed
 

build/Dockerfile

@@ -65,6 +65,8 @@ RUN cargo chef cook --release --recipe-path recipe.json
 
 # Build application
 COPY ./offchain/ .
+# needed to log commit hash in runtime
+COPY ./.git ../ 
 RUN cargo build --release
 
 #

offchain/Cargo.toml

@@ -37,6 +37,7 @@ awc = "3.2"
 axum = "0.6"
 backoff = "0.4"
 base64 = "0.21"
+built = "0.6"
 byteorder = "1.4"
 clap = "4.4"
 diesel = "2.1"

offchain/advance-runner/src/main.rs

@@ -2,14 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0 (see LICENSE)
 
 use advance_runner::config::AdvanceRunnerConfig;
-use tracing::info;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config = AdvanceRunnerConfig::parse()?;
 
     log::configure(&config.log_config);
 
-    info!(?config, "Starting Advance Runner");
+    log::log_service_start(&config, "Advance Runner");
+
     advance_runner::run(config).await.map_err(|e| e.into())
 }

offchain/authority-claimer/src/main.rs

@@ -3,7 +3,6 @@
 
 use authority_claimer::config::Config;
 use std::error::Error;
-use tracing::info;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
@@ -13,7 +12,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
     // Setting up the logging environment.
     log::configure(&config.authority_claimer_config.log_config);
 
-    info!(?config, "Starting Authority Claimer");
+    //Log Service info
+    log::log_service_start(&config, "Authority Claimer");
 
     authority_claimer::run(config).await
 }

offchain/dispatcher/src/dispatcher.rs

@@ -25,7 +25,7 @@ pub async fn start(
     config: DispatcherConfig,
     metrics: DispatcherMetrics,
 ) -> Result<(), DispatcherError> {
-    info!("Setting up dispatcher with config: {:?}", config);
+    info!("Setting up dispatcher");
 
     let dapp_metadata = DAppMetadata {
         chain_id: config.tx_config.chain_id,

offchain/dispatcher/src/main.rs

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0 (see LICENSE)
 
 use log;
-use tracing::info;
 
 // NOTE: doesn't support History upgradability.
 // NOTE: doesn't support changing epoch_duration in the middle of things.
@@ -12,6 +11,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     log::configure(&config.dispatcher_config.log_config);
 
-    info!(?config, "Starting Dispatcher");
+    log::log_service_start(&config, "Dispatcher");
+
     dispatcher::run(config).await.map_err(|e| e.into())
 }

offchain/graphql-server/src/main.rs

@@ -5,14 +5,13 @@ use clap::Parser;
 
 use graphql_server::{CLIConfig, GraphQLConfig};
 
-use tracing::info;
-
 #[actix_web::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: GraphQLConfig = CLIConfig::parse().into();
 
     log::configure(&config.log_config);
 
-    info!(?config, "Starting GraphQL Server");
+    log::log_service_start(&config, "GraphQL Server");
+
     graphql_server::run(config).await.map_err(|e| e.into())
 }

offchain/host-runner/src/main.rs

@@ -16,7 +16,6 @@ use futures_util::FutureExt;
 use std::sync::{atomic::AtomicBool, atomic::Ordering, Arc};
 use std::time::Duration;
 use tokio::sync::oneshot;
-use tracing::info;
 
 use clap::Parser;
 use config::{CLIConfig, Config};
@@ -36,7 +35,7 @@ async fn main() {
 
     log::configure(&config.log_config);
 
-    info!(?config, "Starting Host Runner");
+    log::log_service_start(&config, "Host Runner");
 
     let controller =
         Controller::new(Duration::from_millis(config.finish_timeout));

offchain/indexer/src/main.rs

@@ -4,14 +4,14 @@
 use clap::Parser;
 
 use indexer::{CLIConfig, IndexerConfig};
-use tracing::info;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: IndexerConfig = CLIConfig::parse().into();
 
     log::configure(&config.log_config);
 
-    info!(?config, "Starting Indexer");
+    log::log_service_start(&config, "Indexer");
+
     indexer::run(config).await.map_err(|e| e.into())
 }

offchain/inspect-server/src/main.rs

@@ -4,15 +4,14 @@
 use clap::Parser;
 
 use inspect_server::{config::CLIConfig, InspectServerConfig};
-use tracing::info;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: InspectServerConfig = CLIConfig::parse().into();
 
     log::configure(&config.log_config);
 
-    info!(?config, "Starting Inspect Server");
+    log::log_service_start(&config, "Inspect Server");
 
     inspect_server::run(config).await.map_err(|e| e.into())
 }

offchain/log/Cargo.toml

@@ -5,5 +5,10 @@ license.workspace = true
 version.workspace = true
 
 [dependencies]
+built.workspace = true
 clap = { workspace = true, features = ["derive", "env"] }
+tracing.workspace = true
 tracing-subscriber = { workspace = true, features = ["env-filter"] }
+
+[build-dependencies]
+built = { workspace = true, features = ["git2"] }

offchain/log/build.rs

@@ -0,0 +1,6 @@
+use built;
+
+pub(crate) fn main() {
+    built::write_built_file()
+        .expect("Failed to acquire build-time information");
+}

offchain/log/src/lib.rs

@@ -1,6 +1,15 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+use std::fmt::Debug;
+
 use clap::Parser;
+use tracing::info;
 use tracing_subscriber::filter::{EnvFilter, LevelFilter};
 
+pub mod built_info {
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
 #[derive(Debug, Parser)]
 #[command(name = "log_config")]
 pub struct LogEnvCliConfig {
@@ -52,3 +61,11 @@ pub fn configure(config: &LogConfig) {
         subscribe_builder.init();
     }
 }
+
+pub fn log_service_start<C: Debug>(config: &C, service_name: &str) {
+    let git_ref = built_info::GIT_HEAD_REF.ok_or("N/A").unwrap();
+    let git_hash = built_info::GIT_COMMIT_HASH.ok_or("N/A").unwrap();
+
+    let message = format!("Starting {service} (version={version}, git ref={git_ref}, git hash={git_hash}) with config {:?}",config, service = service_name, version = built_info::PKG_VERSION, git_ref = git_ref, git_hash = git_hash);
+    info!(message);
+}

offchain/state-server/src/main.rs

@@ -10,7 +10,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     log::configure(&config.log_config);
 
-    tracing::info!(?config, "Starting State Server");
+    log::log_service_start(&config, "State Server");
 
     state_server::run_server::<RollupsState>(config.state_server_config)
         .await