Struct Metrics

pub struct Metrics;

Metrics container with constants for Prometheus metric collection.

Contains identifiers for gauges, counters, and histograms used to monitor engine operations when the metrics feature is enabled. Metrics track:

• Block progression through safety levels (unsafe → finalized)
• Task execution success/failure rates by type
• Engine API method call latencies

Usage

use metrics::{counter, gauge, histogram};
use kona_engine::Metrics;

// Track successful task execution
counter!(Metrics::ENGINE_TASK_SUCCESS, "task" => Metrics::INSERT_TASK_LABEL);

// Record block height at safety level
gauge!(Metrics::BLOCK_LABELS, block_num as f64, "level" => Metrics::SAFE_BLOCK_LABEL);

// Time Engine API calls
histogram!(Metrics::ENGINE_METHOD_REQUEST_DURATION, duration.as_secs_f64());

Implementations

impl Metrics

pub const BLOCK_LABELS: &str = "kona_node_block_labels"

Identifier for the gauge that tracks block labels.

pub const UNSAFE_BLOCK_LABEL: &str = "unsafe"

Unsafe block label.

pub const CROSS_UNSAFE_BLOCK_LABEL: &str = "cross-unsafe"

Cross-unsafe block label.

pub const LOCAL_SAFE_BLOCK_LABEL: &str = "local-safe"

Local-safe block label.

pub const SAFE_BLOCK_LABEL: &str = "safe"

Safe block label.

pub const FINALIZED_BLOCK_LABEL: &str = "finalized"

Finalized block label.

pub const ENGINE_TASK_SUCCESS: &str = "kona_node_engine_task_count"

Identifier for the counter that records engine task counts.

pub const ENGINE_TASK_FAILURE: &str = "kona_node_engine_task_failure"

Identifier for the counter that records engine task counts.

pub const INSERT_TASK_LABEL: &str = "insert"

Insert task label.

pub const CONSOLIDATE_TASK_LABEL: &str = "consolidate"

Consolidate task label.

pub const FORKCHOICE_TASK_LABEL: &str = "forkchoice-update"

Forkchoice task label.

pub const BUILD_TASK_LABEL: &str = "build"

Build task label.

pub const FINALIZE_TASK_LABEL: &str = "finalize"

Finalize task label.

pub const ENGINE_METHOD_REQUEST_DURATION: &str = "kona_node_engine_method_request_duration"

Identifier for the histogram that tracks engine method call time.

pub const FORKCHOICE_UPDATE_METHOD: &str = "engine_forkchoiceUpdated"

engine_forkchoiceUpdatedV<N> label

pub const NEW_PAYLOAD_METHOD: &str = "engine_newPayload"

engine_newPayloadV<N> label.

pub const GET_PAYLOAD_METHOD: &str = "engine_getPayload"

engine_getPayloadV<N> label.

pub const ENGINE_RESET_COUNT: &str = "kona_node_engine_reset_count"

Identifier for the counter that tracks the number of times the engine has been reset.

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Metrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.