snarkos-node-metrics 4.6.2

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkOS library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub mod names;

// Expose the names at the crate level for easy access.
pub use names::*;

// Re-export the snarkVM metrics.
pub use snarkvm::metrics::*;

#[cfg(not(feature = "serial"))]
use rayon::prelude::*;

#[cfg(feature = "locktick")]
use locktick::parking_lot::Mutex;
#[cfg(not(feature = "locktick"))]
use parking_lot::Mutex;
use snarkvm::{
    ledger::narwhal::TransmissionID,
    prelude::{Block, Network, cfg_iter},
};
use std::{
    collections::HashMap,
    net::SocketAddr,
    sync::{
        Arc,
        atomic::{AtomicUsize, Ordering},
    },
};
use time::OffsetDateTime;

/// Initializes the metrics and returns a handle to the task running the metrics exporter.
pub fn initialize_metrics(ip: Option<SocketAddr>) {
    // Build the Prometheus exporter.
    let builder = metrics_exporter_prometheus::PrometheusBuilder::new();
    if let Some(ip) = ip { builder.with_http_listener(ip) } else { builder }
        .install()
        .expect("can't build the prometheus exporter");

    // Register the snarkVM metrics.
    snarkvm::metrics::register_metrics();

    // Register the metrics so they exist on init.
    for name in crate::names::GAUGE_NAMES {
        register_gauge(name);
    }
    for name in crate::names::COUNTER_NAMES {
        register_counter(name);
    }
    for name in crate::names::HISTOGRAM_NAMES {
        register_histogram(name);
    }

    // Set the build information metric
    set_build_info();
}

pub fn update_block_metrics<N: Network>(block: &Block<N>) {
    use snarkvm::ledger::ConfirmedTransaction;

    let accepted_deploy = AtomicUsize::new(0);
    let accepted_execute = AtomicUsize::new(0);
    let rejected_deploy = AtomicUsize::new(0);
    let rejected_execute = AtomicUsize::new(0);

    // Add transaction to atomic counter based on enum type match.
    cfg_iter!(block.transactions()).for_each(|tx| match tx {
        ConfirmedTransaction::AcceptedDeploy(_, _, _) => {
            accepted_deploy.fetch_add(1, Ordering::Relaxed);
        }
        ConfirmedTransaction::AcceptedExecute(_, _, _) => {
            accepted_execute.fetch_add(1, Ordering::Relaxed);
        }
        ConfirmedTransaction::RejectedDeploy(_, _, _, _) => {
            rejected_deploy.fetch_add(1, Ordering::Relaxed);
        }
        ConfirmedTransaction::RejectedExecute(_, _, _, _) => {
            rejected_execute.fetch_add(1, Ordering::Relaxed);
        }
    });

    increment_gauge(blocks::ACCEPTED_DEPLOY, accepted_deploy.load(Ordering::Relaxed) as f64);
    increment_gauge(blocks::ACCEPTED_EXECUTE, accepted_execute.load(Ordering::Relaxed) as f64);
    increment_gauge(blocks::REJECTED_DEPLOY, rejected_deploy.load(Ordering::Relaxed) as f64);
    increment_gauge(blocks::REJECTED_EXECUTE, rejected_execute.load(Ordering::Relaxed) as f64);

    // Update aborted transactions and solutions.
    increment_gauge(blocks::ABORTED_TRANSACTIONS, block.aborted_transaction_ids().len() as f64);
    increment_gauge(blocks::ABORTED_SOLUTIONS, block.aborted_solution_ids().len() as f64);
}

pub fn add_transmission_latency_metric<N: Network>(
    transmissions_tracker: &Arc<Mutex<HashMap<TransmissionID<N>, i64>>>,
    block: &Block<N>,
) {
    // The age at which we consider a transmission "stale".
    const AGE_THRESHOLD_SECONDS: i32 = 30 * 60; // 30 minutes

    // Retrieve all solution IDs (including aborted).
    let solution_ids: std::collections::HashSet<_> =
        block.solutions().solution_ids().chain(block.aborted_solution_ids()).collect();

    // Retrieve all transaction IDs (including aborted).
    let transaction_ids: std::collections::HashSet<_> =
        block.transaction_ids().chain(block.aborted_transaction_ids()).collect();

    let mut transmissions_tracker = transmissions_tracker.lock();
    let ts_now = OffsetDateTime::now_utc().unix_timestamp();

    // Determine which keys to remove.
    let keys_to_remove = cfg_iter!(&*transmissions_tracker)
        .flat_map(|(transmission_id, timestamp)| {
            let elapsed_time = std::time::Duration::from_secs((ts_now - *timestamp) as u64);

            if elapsed_time.as_secs() > AGE_THRESHOLD_SECONDS as u64 {
                // This entry is stale-- remove it from transmission queue and record it as a stale transmission.
                match transmission_id {
                    TransmissionID::Solution(..) => increment_counter(consensus::STALE_UNCONFIRMED_SOLUTIONS),
                    TransmissionID::Transaction(..) => increment_counter(consensus::STALE_UNCONFIRMED_TRANSACTIONS),
                    TransmissionID::Ratification => {}
                }
                Some(*transmission_id)
            } else {
                let transmission_type = match transmission_id {
                    TransmissionID::Solution(solution_id, _) if solution_ids.contains(solution_id) => Some("solution"),
                    TransmissionID::Transaction(transaction_id, _) if transaction_ids.contains(transaction_id) => {
                        Some("transaction")
                    }
                    // Either a ratification, or the transmission was not included in the block
                    _ => None,
                };

                if let Some(transmission_type_string) = transmission_type {
                    histogram_label(
                        consensus::TRANSMISSION_LATENCY,
                        "transmission_type",
                        transmission_type_string.to_owned(),
                        elapsed_time.as_secs_f64(),
                    );
                    Some(*transmission_id)
                } else {
                    None
                }
            }
        })
        .collect::<Vec<_>>();

    // Remove keys of stale or seen transmissions.
    for key in keys_to_remove {
        transmissions_tracker.remove(&key);
    }
}

// Include the generated build information
mod built_info {
    include!(concat!(env!("OUT_DIR"), "/built.rs"));
}

/// Sets the build information metric with version details as labels.
/// The resulting metric will show as:
/// snarkos_build_info{version="4.2.1",git_commit="abc123",git_branch="main",features="cuda,metrics"} 1
pub fn set_build_info() {
    let version = built_info::PKG_VERSION;
    let git_commit = built_info::GIT_COMMIT_HASH.unwrap_or("unknown");
    let git_branch = built_info::GIT_HEAD_REF.unwrap_or("unknown");
    let features = built_info::FEATURES_LOWERCASE_STR.replace(' ', "");

    ::metrics::gauge!(build::BUILD_INFO, "version" => version.to_string()).set(1.0);
    ::metrics::gauge!(build::BUILD_INFO, "git_commit" => git_commit.to_string()).set(1.0);
    ::metrics::gauge!(build::BUILD_INFO, "git_branch" => git_branch.to_string()).set(1.0);
    ::metrics::gauge!(build::BUILD_INFO, "features" => features).set(1.0);
}