use crate::{BeaconChain, BeaconChainTypes}; use lazy_static::lazy_static; pub use lighthouse_metrics::*; use slot_clock::SlotClock; use types::{BeaconState, Epoch, EthSpec, Hash256, Slot}; lazy_static! { /* * Block Processing */ pub static ref BLOCK_PROCESSING_REQUESTS: Result = try_create_int_counter( "beacon_block_processing_requests_total", "Count of blocks submitted for processing" ); pub static ref BLOCK_PROCESSING_SUCCESSES: Result = try_create_int_counter( "beacon_block_processing_successes_total", "Count of blocks processed without error" ); pub static ref BLOCK_PROCESSING_TIMES: Result = try_create_histogram("beacon_block_processing_seconds", "Full runtime of block processing"); pub static ref BLOCK_PROCESSING_BLOCK_ROOT: Result = try_create_histogram( "beacon_block_processing_block_root_seconds", "Time spent calculating the block root when processing a block." ); pub static ref BLOCK_PROCESSING_DB_READ: Result = try_create_histogram( "beacon_block_processing_db_read_seconds", "Time spent loading block and state from DB for block processing" ); pub static ref BLOCK_PROCESSING_CATCHUP_STATE: Result = try_create_histogram( "beacon_block_processing_catch_up_state_seconds", "Time spent skipping slots on a state before processing a block." ); pub static ref BLOCK_PROCESSING_COMMITTEE: Result = try_create_histogram( "beacon_block_processing_committee_building_seconds", "Time spent building/obtaining committees for block processing." ); pub static ref BLOCK_PROCESSING_SIGNATURE: Result = try_create_histogram( "beacon_block_processing_signature_seconds", "Time spent doing signature verification for a block." ); pub static ref BLOCK_PROCESSING_CORE: Result = try_create_histogram( "beacon_block_processing_core_seconds", "Time spent doing the core per_block_processing state processing." ); pub static ref BLOCK_PROCESSING_STATE_ROOT: Result = try_create_histogram( "beacon_block_processing_state_root_seconds", "Time spent calculating the state root when processing a block." ); pub static ref BLOCK_PROCESSING_DB_WRITE: Result = try_create_histogram( "beacon_block_processing_db_write_seconds", "Time spent writing a newly processed block and state to DB" ); pub static ref BLOCK_PROCESSING_ATTESTATION_OBSERVATION: Result = try_create_histogram( "beacon_block_processing_attestation_observation_seconds", "Time spent hashing and remembering all the attestations in the block" ); /* * Block Production */ pub static ref BLOCK_PRODUCTION_REQUESTS: Result = try_create_int_counter( "beacon_block_production_requests_total", "Count of all block production requests" ); pub static ref BLOCK_PRODUCTION_SUCCESSES: Result = try_create_int_counter( "beacon_block_production_successes_total", "Count of blocks successfully produced." ); pub static ref BLOCK_PRODUCTION_TIMES: Result = try_create_histogram("beacon_block_production_seconds", "Full runtime of block production"); /* * Block Statistics */ pub static ref OPERATIONS_PER_BLOCK_ATTESTATION: Result = try_create_histogram( "beacon_operations_per_block_attestation_total", "Number of attestations in a block" ); /* * Unaggregated Attestation Verification */ pub static ref UNAGGREGATED_ATTESTATION_PROCESSING_REQUESTS: Result = try_create_int_counter( "beacon_unaggregated_attestation_processing_requests_total", "Count of all unaggregated attestations submitted for processing" ); pub static ref UNAGGREGATED_ATTESTATION_PROCESSING_SUCCESSES: Result = try_create_int_counter( "beacon_unaggregated_attestation_processing_successes_total", "Number of unaggregated attestations verified for gossip" ); pub static ref UNAGGREGATED_ATTESTATION_GOSSIP_VERIFICATION_TIMES: Result = try_create_histogram( "beacon_unaggregated_attestation_gossip_verification_seconds", "Full runtime of aggregated attestation gossip verification" ); /* * Aggregated Attestation Verification */ pub static ref AGGREGATED_ATTESTATION_PROCESSING_REQUESTS: Result = try_create_int_counter( "beacon_aggregated_attestation_processing_requests_total", "Count of all aggregated attestations submitted for processing" ); pub static ref AGGREGATED_ATTESTATION_PROCESSING_SUCCESSES: Result = try_create_int_counter( "beacon_aggregated_attestation_processing_successes_total", "Number of aggregated attestations verified for gossip" ); pub static ref AGGREGATED_ATTESTATION_GOSSIP_VERIFICATION_TIMES: Result = try_create_histogram( "beacon_aggregated_attestation_gossip_verification_seconds", "Full runtime of aggregated attestation gossip verification" ); /* * General Attestation Processing */ pub static ref ATTESTATION_PROCESSING_APPLY_TO_AGG_POOL: Result = try_create_histogram( "beacon_attestation_processing_apply_to_agg_pool", "Time spent applying an attestation to the naive aggregation pool" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_MAPS_WRITE_LOCK: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_maps_write_lock", "Time spent waiting for the maps write lock when adding to the agg poll" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_PRUNE: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_prune", "Time spent for the agg pool to prune" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_INSERT: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_insert", "Time spent for the outer pool.insert() function of agg pool" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_CORE_INSERT: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_core_insert", "Time spent for the core map.insert() function of agg pool" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_AGGREGATION: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_aggregation", "Time spent doing signature aggregation when adding to the agg poll" ); pub static ref ATTESTATION_PROCESSING_AGG_POOL_CREATE_MAP: Result = try_create_histogram( "beacon_attestation_processing_agg_pool_create_map", "Time spent for creating a map for a new slot" ); pub static ref ATTESTATION_PROCESSING_APPLY_TO_OP_POOL: Result = try_create_histogram( "beacon_attestation_processing_apply_to_op_pool", "Time spent applying an attestation to the block inclusion pool" ); /* * Attestation Processing */ pub static ref ATTESTATION_PROCESSING_SHUFFLING_CACHE_WAIT_TIMES: Result = try_create_histogram( "beacon_attestation_processing_shuffling_cache_wait_seconds", "Time spent on waiting for the shuffling cache lock during attestation processing" ); pub static ref ATTESTATION_PROCESSING_COMMITTEE_BUILDING_TIMES: Result = try_create_histogram( "beacon_attestation_processing_committee_building_seconds", "Time spent on building committees during attestation processing" ); pub static ref ATTESTATION_PROCESSING_STATE_READ_TIMES: Result = try_create_histogram( "beacon_attestation_processing_state_read_seconds", "Time spent on reading the state during attestation processing" ); pub static ref ATTESTATION_PROCESSING_STATE_SKIP_TIMES: Result = try_create_histogram( "beacon_attestation_processing_state_skip_seconds", "Time spent on reading the state during attestation processing" ); pub static ref ATTESTATION_PROCESSING_SIGNATURE_SETUP_TIMES: Result = try_create_histogram( "beacon_attestation_processing_signature_setup_seconds", "Time spent on setting up for the signature verification of attestation processing" ); pub static ref ATTESTATION_PROCESSING_SIGNATURE_TIMES: Result = try_create_histogram( "beacon_attestation_processing_signature_seconds", "Time spent on the signature verification of attestation processing" ); /* * Shuffling cache */ pub static ref SHUFFLING_CACHE_HITS: Result = try_create_int_counter("beacon_shuffling_cache_hits_total", "Count of times shuffling cache fulfils request"); pub static ref SHUFFLING_CACHE_MISSES: Result = try_create_int_counter("beacon_shuffling_cache_misses_total", "Count of times shuffling cache fulfils request"); /* * Attestation Production */ pub static ref ATTESTATION_PRODUCTION_REQUESTS: Result = try_create_int_counter( "beacon_attestation_production_requests_total", "Count of all attestation production requests" ); pub static ref ATTESTATION_PRODUCTION_SUCCESSES: Result = try_create_int_counter( "beacon_attestation_production_successes_total", "Count of attestations processed without error" ); pub static ref ATTESTATION_PRODUCTION_TIMES: Result = try_create_histogram( "beacon_attestation_production_seconds", "Full runtime of attestation production" ); } // Second lazy-static block is used to account for macro recursion limit. lazy_static! { /* * Fork Choice */ pub static ref FORK_CHOICE_REQUESTS: Result = try_create_int_counter( "beacon_fork_choice_requests_total", "Count of occasions where fork choice has tried to find a head" ); pub static ref FORK_CHOICE_ERRORS: Result = try_create_int_counter( "beacon_fork_choice_errors_total", "Count of occasions where fork choice has returned an error when trying to find a head" ); pub static ref FORK_CHOICE_CHANGED_HEAD: Result = try_create_int_counter( "beacon_fork_choice_changed_head_total", "Count of occasions fork choice has found a new head" ); pub static ref FORK_CHOICE_REORG_COUNT: Result = try_create_int_counter( "beacon_fork_choice_reorg_total", "Count of occasions fork choice has switched to a different chain" ); pub static ref FORK_CHOICE_TIMES: Result = try_create_histogram("beacon_fork_choice_seconds", "Full runtime of fork choice"); pub static ref FORK_CHOICE_FIND_HEAD_TIMES: Result = try_create_histogram("beacon_fork_choice_find_head_seconds", "Full runtime of fork choice find_head function"); pub static ref FORK_CHOICE_PROCESS_BLOCK_TIMES: Result = try_create_histogram( "beacon_fork_choice_process_block_seconds", "Time taken to add a block and all attestations to fork choice" ); pub static ref FORK_CHOICE_PROCESS_ATTESTATION_TIMES: Result = try_create_histogram( "beacon_fork_choice_process_attestation_seconds", "Time taken to add an attestation to fork choice" ); pub static ref BALANCES_CACHE_HITS: Result = try_create_int_counter("beacon_balances_cache_hits_total", "Count of times balances cache fulfils request"); pub static ref BALANCES_CACHE_MISSES: Result = try_create_int_counter("beacon_balances_cache_misses_total", "Count of times balances cache fulfils request"); /* * Persisting BeaconChain components to disk */ pub static ref PERSIST_HEAD: Result = try_create_histogram("beacon_persist_head", "Time taken to persist the canonical head"); pub static ref PERSIST_OP_POOL: Result = try_create_histogram("beacon_persist_op_pool", "Time taken to persist the operations pool"); pub static ref PERSIST_ETH1_CACHE: Result = try_create_histogram("beacon_persist_eth1_cache", "Time taken to persist the eth1 caches"); pub static ref PERSIST_FORK_CHOICE: Result = try_create_histogram("beacon_persist_fork_choice", "Time taken to persist the fork choice struct"); /* * Eth1 */ pub static ref DEFAULT_ETH1_VOTES: Result = try_create_int_counter("beacon_eth1_default_votes", "Count of times we have voted default value for eth1 data"); /* * Chain Head */ pub static ref UPDATE_HEAD_TIMES: Result = try_create_histogram("beacon_update_head_seconds", "Time taken to update the canonical head"); pub static ref HEAD_STATE_SLOT: Result = try_create_int_gauge("beacon_head_state_slot", "Slot of the block at the head of the chain"); pub static ref HEAD_STATE_ROOT: Result = try_create_int_gauge("beacon_head_state_root", "Root of the block at the head of the chain"); pub static ref HEAD_STATE_LATEST_BLOCK_SLOT: Result = try_create_int_gauge("beacon_head_state_latest_block_slot", "Latest block slot at the head of the chain"); pub static ref HEAD_STATE_CURRENT_JUSTIFIED_ROOT: Result = try_create_int_gauge("beacon_head_state_current_justified_root", "Current justified root at the head of the chain"); pub static ref HEAD_STATE_CURRENT_JUSTIFIED_EPOCH: Result = try_create_int_gauge("beacon_head_state_current_justified_epoch", "Current justified epoch at the head of the chain"); pub static ref HEAD_STATE_PREVIOUS_JUSTIFIED_ROOT: Result = try_create_int_gauge("beacon_head_state_previous_justified_root", "Previous justified root at the head of the chain"); pub static ref HEAD_STATE_PREVIOUS_JUSTIFIED_EPOCH: Result = try_create_int_gauge("beacon_head_state_previous_justified_epoch", "Previous justified epoch at the head of the chain"); pub static ref HEAD_STATE_FINALIZED_ROOT: Result = try_create_int_gauge("beacon_head_state_finalized_root", "Finalized root at the head of the chain"); pub static ref HEAD_STATE_FINALIZED_EPOCH: Result = try_create_int_gauge("beacon_head_state_finalized_epoch", "Finalized epoch at the head of the chain"); pub static ref HEAD_STATE_TOTAL_VALIDATORS: Result = try_create_int_gauge("beacon_head_state_total_validators_total", "Count of validators at the head of the chain"); pub static ref HEAD_STATE_ACTIVE_VALIDATORS: Result = try_create_int_gauge("beacon_head_state_active_validators_total", "Count of active validators at the head of the chain"); pub static ref HEAD_STATE_VALIDATOR_BALANCES: Result = try_create_int_gauge("beacon_head_state_validator_balances_total", "Sum of all validator balances at the head of the chain"); pub static ref HEAD_STATE_SLASHED_VALIDATORS: Result = try_create_int_gauge("beacon_head_state_slashed_validators_total", "Count of all slashed validators at the head of the chain"); pub static ref HEAD_STATE_WITHDRAWN_VALIDATORS: Result = try_create_int_gauge("beacon_head_state_withdrawn_validators_total", "Sum of all validator balances at the head of the chain"); pub static ref HEAD_STATE_ETH1_DEPOSIT_INDEX: Result = try_create_int_gauge("beacon_head_state_eth1_deposit_index", "Eth1 deposit index at the head of the chain"); /* * Operation Pool */ pub static ref OP_POOL_NUM_ATTESTATIONS: Result = try_create_int_gauge("beacon_op_pool_attestations_total", "Count of attestations in the op pool"); pub static ref OP_POOL_NUM_ATTESTER_SLASHINGS: Result = try_create_int_gauge("beacon_op_pool_attester_slashings_total", "Count of attester slashings in the op pool"); pub static ref OP_POOL_NUM_PROPOSER_SLASHINGS: Result = try_create_int_gauge("beacon_op_pool_proposer_slashings_total", "Count of proposer slashings in the op pool"); pub static ref OP_POOL_NUM_VOLUNTARY_EXITS: Result = try_create_int_gauge("beacon_op_pool_voluntary_exits_total", "Count of voluntary exits in the op pool"); /* * Participation Metrics */ pub static ref PARTICIPATION_PREV_EPOCH_ATTESTER: Result = try_create_float_gauge( "beacon_participation_prev_epoch_attester", "Ratio of attesting balances to total balances" ); pub static ref PARTICIPATION_PREV_EPOCH_TARGET_ATTESTER: Result = try_create_float_gauge( "beacon_participation_prev_epoch_target_attester", "Ratio of target-attesting balances to total balances" ); pub static ref PARTICIPATION_PREV_EPOCH_HEAD_ATTESTER: Result = try_create_float_gauge( "beacon_participation_prev_epoch_head_attester", "Ratio of head-attesting balances to total balances" ); /* * Attestation Observation Metrics */ pub static ref ATTN_OBSERVATION_PREV_EPOCH_ATTESTERS: Result = try_create_int_gauge( "beacon_attn_observation_epoch_attesters", "Count of attesters that have been seen by the beacon chain in the previous epoch" ); pub static ref ATTN_OBSERVATION_PREV_EPOCH_AGGREGATORS: Result = try_create_int_gauge( "beacon_attn_observation_epoch_aggregators", "Count of aggregators that have been seen by the beacon chain in the previous epoch" ); } /// Scrape the `beacon_chain` for metrics that are not constantly updated (e.g., the present slot, /// head state info, etc) and update the Prometheus `DEFAULT_REGISTRY`. pub fn scrape_for_metrics(beacon_chain: &BeaconChain) { if let Ok(head) = beacon_chain.head() { scrape_head_state::(&head.beacon_state, head.beacon_state_root) } if let Some(slot) = beacon_chain.slot_clock.now() { scrape_attestation_observation(slot, beacon_chain); } set_gauge_by_usize( &OP_POOL_NUM_ATTESTATIONS, beacon_chain.op_pool.num_attestations(), ); set_gauge_by_usize( &OP_POOL_NUM_ATTESTER_SLASHINGS, beacon_chain.op_pool.num_attester_slashings(), ); set_gauge_by_usize( &OP_POOL_NUM_PROPOSER_SLASHINGS, beacon_chain.op_pool.num_proposer_slashings(), ); set_gauge_by_usize( &OP_POOL_NUM_VOLUNTARY_EXITS, beacon_chain.op_pool.num_voluntary_exits(), ); } /// Scrape the given `state` assuming it's the head state, updating the `DEFAULT_REGISTRY`. fn scrape_head_state(state: &BeaconState, state_root: Hash256) { set_gauge_by_slot(&HEAD_STATE_SLOT, state.slot); set_gauge_by_hash(&HEAD_STATE_ROOT, state_root); set_gauge_by_slot( &HEAD_STATE_LATEST_BLOCK_SLOT, state.latest_block_header.slot, ); set_gauge_by_hash( &HEAD_STATE_CURRENT_JUSTIFIED_ROOT, state.current_justified_checkpoint.root, ); set_gauge_by_epoch( &HEAD_STATE_CURRENT_JUSTIFIED_EPOCH, state.current_justified_checkpoint.epoch, ); set_gauge_by_hash( &HEAD_STATE_PREVIOUS_JUSTIFIED_ROOT, state.previous_justified_checkpoint.root, ); set_gauge_by_epoch( &HEAD_STATE_PREVIOUS_JUSTIFIED_EPOCH, state.previous_justified_checkpoint.epoch, ); set_gauge_by_hash(&HEAD_STATE_FINALIZED_ROOT, state.finalized_checkpoint.root); set_gauge_by_epoch( &HEAD_STATE_FINALIZED_EPOCH, state.finalized_checkpoint.epoch, ); set_gauge_by_usize(&HEAD_STATE_TOTAL_VALIDATORS, state.validators.len()); set_gauge_by_u64(&HEAD_STATE_VALIDATOR_BALANCES, state.balances.iter().sum()); set_gauge_by_usize( &HEAD_STATE_ACTIVE_VALIDATORS, state .validators .iter() .filter(|v| v.is_active_at(state.current_epoch())) .count(), ); set_gauge_by_usize( &HEAD_STATE_SLASHED_VALIDATORS, state.validators.iter().filter(|v| v.slashed).count(), ); set_gauge_by_usize( &HEAD_STATE_WITHDRAWN_VALIDATORS, state .validators .iter() .filter(|v| v.is_withdrawable_at(state.current_epoch())) .count(), ); set_gauge_by_u64(&HEAD_STATE_ETH1_DEPOSIT_INDEX, state.eth1_deposit_index); } fn scrape_attestation_observation(slot_now: Slot, chain: &BeaconChain) { let prev_epoch = slot_now.epoch(T::EthSpec::slots_per_epoch()) - 1; if let Some(count) = chain .observed_attesters .read() .observed_validator_count(prev_epoch) { set_gauge_by_usize(&ATTN_OBSERVATION_PREV_EPOCH_ATTESTERS, count); } if let Some(count) = chain .observed_aggregators .read() .observed_validator_count(prev_epoch) { set_gauge_by_usize(&ATTN_OBSERVATION_PREV_EPOCH_AGGREGATORS, count); } } fn set_gauge_by_slot(gauge: &Result, value: Slot) { set_gauge(gauge, value.as_u64() as i64); } fn set_gauge_by_epoch(gauge: &Result, value: Epoch) { set_gauge(gauge, value.as_u64() as i64); } fn set_gauge_by_hash(gauge: &Result, value: Hash256) { set_gauge(gauge, value.to_low_u64_le() as i64); } fn set_gauge_by_usize(gauge: &Result, value: usize) { set_gauge(gauge, value as i64); } fn set_gauge_by_u64(gauge: &Result, value: u64) { set_gauge(gauge, value as i64); }