Skip to content

How to configure metrics

Rollkit can report and serve the Prometheus metrics, which in their turn can be consumed by Prometheus collector(s).

This functionality is disabled by default.

To enable the Prometheus metrics, set instrumentation.prometheus=true in your CometBFT node's config file located at $CMTHOME/config/config.toml.

Metrics will be served under /metrics on 26660 port by default. The listening address (default: localhost:26660) can be changed in the config file using instrumentation.prometheus_listen_addr.

List of available metrics

The following metrics are available, grouped by their subsystem:

ABCI

NameTypeTagsDescription
cometbft_abci_connection_method_timing_secondsHistogramchain_id, method, typeTiming for each ABCI method.

sequencer

NameTypeTagsDescription
cometbft_sequencer_heightGaugechain_idHeight of the chain.
cometbft_sequencer_num_txsGaugechain_idNumber of transactions.
cometbft_sequencer_block_size_bytesGaugechain_idSize of the block.
cometbft_sequencer_total_txsGaugechain_idTotal number of transactions.
cometbft_sequencer_latest_block_heightGaugechain_idThe latest block height.

mempool

NameTypeTagsDescription
cometbft_mempool_sizeGaugechain_idSize of the mempool (number of uncommitted transactions).
cometbft_mempool_size_bytesGaugechain_idTotal size of the mempool in bytes.
cometbft_mempool_tx_size_bytesHistogramchain_idTransaction sizes in bytes.
cometbft_mempool_failed_txsCounterchain_idNumber of failed transactions.
cometbft_mempool_rejected_txsCounterchain_idNumber of rejected transactions.
cometbft_mempool_evicted_txsCounterchain_idNumber of evicted transactions.
cometbft_mempool_recheck_timesCounterchain_idNumber of times transactions are rechecked in the mempool.

p2p

NameTypeTagsDescription
cometbft_p2p_peersGaugechain_idNumber of peers.
cometbft_p2p_peer_receive_bytes_totalCounterpeer_id, chIDNumber of bytes received from a given peer.
cometbft_p2p_peer_send_bytes_totalCounterpeer_id, chIDNumber of bytes sent to a given peer.
cometbft_p2p_peer_pending_send_bytesGaugepeer_idPending bytes to be sent to a given peer.
cometbft_p2p_num_txsGaugepeer_idNumber of transactions submitted by each peer.
cometbft_p2p_message_receive_bytes_totalCountermessage_typeNumber of bytes of each message type received.
cometbft_p2p_message_send_bytes_totalCountermessage_typeNumber of bytes of each message type sent.

In addition to these, go-libp2p metrics are exported as well.

state

NameTypeTagsDescription
cometbft_state_block_processing_timeHistogramchain_idTime spent processing FinalizeBlock.
cometbft_state_consensus_param_updatesCounterchain_idNumber of consensus parameter updates returned by the application since process start.

centralized-sequencer

The centralized-sequencer has its own metrics and configuration, see the centralized sequencer docs for details.

Released under the APACHE-2.0 License