Skip to main content

How to enable Prometheus metrics

Overview

Polygon-SDK can report and serve the Prometheus metrics, which in their turn can be consumed using Prometheus collector(s).

Prometheus metrics are disabled by default. It can be enabled by specifying the listener address using --prometheus flag or Telemetry.prometheus field in config file. Metrics will be served under /metrics on the specified address.

Available metrics

The following metrics are available:

NameTypeDescription
txpool_pending_transactionsGaugeNumber of pending transactions in TxPool
consensus_validatorsGaugeNumber of Validators
consensus_roundsGaugeNumber of Rounds
consensus_num_txsGaugeNumber of Transactions in the latest block
consensus_block_intervalHistogramTime between this and last block in seconds