feat: add info metrics (#234)

Co-authored-by: Manuel Iñaki Bilbao <[email protected]>

Author: ltitanb

.dockerignore

@@ -1,5 +1,4 @@
 target
 Dockerfile
 .dockerignore
-.git
 .gitignore

.github/workflows/release.yml

@@ -37,6 +37,11 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: "stable"
+          fetch-depth: 0
+
+      - name: Log commit hash
+        run: |
+          echo "Releasing commit: $(git rev-parse HEAD)"
 
       - name: Cache Cargo registry
         uses: actions/cache@v3
@@ -107,6 +112,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: "stable"
+          fetch-depth: 0
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -141,6 +147,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: "stable"
+          fetch-depth: 0
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

bin/pbs.rs

@@ -18,8 +18,8 @@ async fn main() -> Result<()> {
 
     let pbs_config = load_pbs_config().await?;
 
+    PbsService::init_metrics(pbs_config.chain)?;
     let state = PbsState::new(pbs_config);
-    PbsService::init_metrics()?;
     let server = PbsService::run::<_, DefaultBuilderApi>(state);
 
     tokio::select! {

bin/src/lib.rs

@@ -11,6 +11,7 @@ pub mod prelude {
         },
         pbs::{BuilderEvent, BuilderEventClient, OnBuilderApiEvent},
         signer::{BlsPublicKey, BlsSignature, EcdsaPublicKey, EcdsaSignature},
+        types::Chain,
         utils::{
             initialize_pbs_tracing_log, initialize_tracing_log, utcnow_ms, utcnow_ns, utcnow_sec,
             utcnow_us,

crates/common/build.rs

@@ -0,0 +1,7 @@
+use std::process::Command;
+
+fn main() {
+    let output = Command::new("git").args(["rev-parse", "HEAD"]).output().unwrap();
+    let git_hash = String::from_utf8(output.stdout).unwrap();
+    println!("cargo:rustc-env=GIT_HASH={git_hash}");
+}

crates/common/src/constants.rs

@@ -2,3 +2,4 @@ pub const APPLICATION_BUILDER_DOMAIN: [u8; 4] = [0, 0, 0, 1];
 pub const GENESIS_VALIDATORS_ROOT: [u8; 32] = [0; 32];
 pub const COMMIT_BOOST_DOMAIN: [u8; 4] = [109, 109, 111, 67];
 pub const COMMIT_BOOST_VERSION: &str = env!("CARGO_PKG_VERSION");
+pub const COMMIT_BOOST_COMMIT: &str = env!("GIT_HASH");

crates/common/src/types.rs

@@ -28,6 +28,15 @@ pub enum Chain {
 
 pub type ForkVersion = [u8; 4];
 
+impl std::fmt::Display for Chain {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            Self::Mainnet | Self::Holesky | Self::Sepolia | Self::Helder => write!(f, "{self:?}"),
+            Self::Custom { .. } => write!(f, "Custom"),
+        }
+    }
+}
+
 impl std::fmt::Debug for Chain {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {

crates/metrics/src/provider.rs

@@ -7,28 +7,33 @@ use axum::{
     response::{IntoResponse, Response},
     routing::get,
 };
-use cb_common::config::ModuleMetricsConfig;
+use cb_common::{
+    config::ModuleMetricsConfig,
+    constants::{COMMIT_BOOST_COMMIT, COMMIT_BOOST_VERSION},
+    types::Chain,
+};
 use eyre::bail;
-use prometheus::{Encoder, Registry, TextEncoder};
+use prometheus::{Encoder, IntGauge, Opts, Registry, TextEncoder};
 use tokio::net::TcpListener;
 use tracing::{error, info, trace, warn};
 
 pub struct MetricsProvider {
+    network: Chain,
     config: ModuleMetricsConfig,
     registry: Registry,
 }
 
 impl MetricsProvider {
-    pub fn new(config: ModuleMetricsConfig, registry: Registry) -> Self {
-        MetricsProvider { config, registry }
+    pub fn new(network: Chain, config: ModuleMetricsConfig, registry: Registry) -> Self {
+        MetricsProvider { network, config, registry }
     }
 
-    pub fn from_registry(registry: Registry) -> eyre::Result<Option<Self>> {
-        Ok(ModuleMetricsConfig::load_from_env()?.map(|config| MetricsProvider { config, registry }))
+    pub fn from_registry(network: Chain, registry: Registry) -> eyre::Result<Option<Self>> {
+        Ok(ModuleMetricsConfig::load_from_env()?.map(|config| Self::new(network, config, registry)))
     }
 
-    pub fn load_and_run(registry: Registry) -> eyre::Result<()> {
-        if let Some(provider) = MetricsProvider::from_registry(registry)? {
+    pub fn load_and_run(network: Chain, registry: Registry) -> eyre::Result<()> {
+        if let Some(provider) = MetricsProvider::from_registry(network, registry)? {
             tokio::spawn(async move {
                 if let Err(err) = provider.run().await {
                     error!("Metrics server error: {:?}", err);
@@ -44,6 +49,15 @@ impl MetricsProvider {
     pub async fn run(self) -> eyre::Result<()> {
         info!("Starting metrics server on port {}", self.config.server_port);
 
+        let opts = Opts::new("info", "Commit Boost info")
+            .const_label("version", COMMIT_BOOST_VERSION)
+            .const_label("commit", COMMIT_BOOST_COMMIT)
+            .const_label("network", self.network.to_string());
+        let info = IntGauge::with_opts(opts).unwrap();
+        info.set(1);
+
+        self.registry.register(Box::new(info)).unwrap();
+
         let router = axum::Router::new()
             .route("/metrics", get(handle_metrics))
             .route("/status", get(handle_status))

crates/pbs/src/service.rs

@@ -1,8 +1,9 @@
 use std::time::Duration;
 
 use cb_common::{
-    constants::COMMIT_BOOST_VERSION,
+    constants::{COMMIT_BOOST_COMMIT, COMMIT_BOOST_VERSION},
     pbs::{BUILDER_API_PATH, GET_STATUS_PATH},
+    types::Chain,
 };
 use cb_metrics::provider::MetricsProvider;
 use eyre::{bail, Context, Result};
@@ -25,7 +26,7 @@ impl PbsService {
         let addr = state.config.endpoint;
         let events_subs =
             state.config.event_publisher.as_ref().map(|e| e.n_subscribers()).unwrap_or_default();
-        info!(version = COMMIT_BOOST_VERSION, ?addr, events_subs, chain =? state.config.chain, "starting PBS service");
+        info!(version = COMMIT_BOOST_VERSION, commit = COMMIT_BOOST_COMMIT, ?addr, events_subs, chain =? state.config.chain, "starting PBS service");
 
         let app = create_app_router::<S, A>(state);
         let listener = TcpListener::bind(addr).await?;
@@ -52,7 +53,7 @@ impl PbsService {
         PBS_METRICS_REGISTRY.register(c).expect("failed to register metric");
     }
 
-    pub fn init_metrics() -> Result<()> {
-        MetricsProvider::load_and_run(PBS_METRICS_REGISTRY.clone())
+    pub fn init_metrics(network: Chain) -> Result<()> {
+        MetricsProvider::load_and_run(network, PBS_METRICS_REGISTRY.clone())
     }
 }

crates/signer/src/service.rs

@@ -21,8 +21,8 @@ use cb_common::{
         },
     },
     config::StartSignerConfig,
-    constants::COMMIT_BOOST_VERSION,
-    types::{Jwt, ModuleId},
+    constants::{COMMIT_BOOST_COMMIT, COMMIT_BOOST_VERSION},
+    types::{Chain, Jwt, ModuleId},
 };
 use cb_metrics::provider::MetricsProvider;
 use eyre::{Context, Result};
@@ -74,10 +74,10 @@ impl SigningService {
         let proxies = manager.proxies();
         let loaded_proxies = proxies.bls_signers.len() + proxies.ecdsa_signers.len();
 
-        info!(version = COMMIT_BOOST_VERSION, modules =? module_ids, port =? config.server_port, loaded_consensus, loaded_proxies, "Starting signing service");
+        info!(version = COMMIT_BOOST_VERSION, commit = COMMIT_BOOST_COMMIT, modules =? module_ids, port =? config.server_port, loaded_consensus, loaded_proxies, "Starting signing service");
 
         let state = SigningState { manager: RwLock::new(manager).into(), jwts: config.jwts.into() };
-        SigningService::init_metrics()?;
+        SigningService::init_metrics(config.chain)?;
 
         let app = axum::Router::new()
             .route(REQUEST_SIGNATURE_PATH, post(handle_request_signature))
@@ -96,8 +96,8 @@ impl SigningService {
             .wrap_err("signer server exited")
     }
 
-    fn init_metrics() -> Result<()> {
-        MetricsProvider::load_and_run(SIGNER_METRICS_REGISTRY.clone())
+    fn init_metrics(network: Chain) -> Result<()> {
+        MetricsProvider::load_and_run(network, SIGNER_METRICS_REGISTRY.clone())
     }
 }