add since column to list of available metrics table

This commit is contained in:
Anton Kaliaev
2018-06-16 11:13:41 +04:00
parent d8fea3ec9d
commit cd11a54f7a

View File

@ -1,29 +1,35 @@
# Metrics # Metrics
Tendermint can serve metrics under `/metrics` RPC endpoint, which can be Tendermint can report and serve the Prometheus metrics, which in their turn can
consumed by Prometheus server. be consumed by Prometheus collector(s).
This functionality is disabled by default. Set `monitoring=true` if your config This functionality is disabled by default.
to enable it.
To enable the Prometheus metrics, set `instrumentation.prometheus=true` if your
config file. Metrics will be served under `/metrics` on 26660 port by default.
Listen address can be changed in the config file (see
`prometheus_listen_addr`).
## List of available metrics ## List of available metrics
| Name | Type | Description | The following metrics are available:
| --------------------------------------- | ------- | ----------------------------------------------------------------------------- |
| consensus_height | Gauge | Height of the chain | | Name | Type | Since | Description |
| consensus_validators | Gauge | Number of validators | | --------------------------------------- | ------- | --------- | ----------------------------------------------------------------------------- |
| consensus_validators_power | Gauge | Total voting power of all validators | | consensus_height | Gauge | 0.20.1 | Height of the chain |
| consensus_missing_validators | Gauge | Number of validators who did not sign | | consensus_validators | Gauge | 0.20.1 | Number of validators |
| consensus_missing_validators_power | Gauge | Total voting power of the missing validators | | consensus_validators_power | Gauge | 0.20.1 | Total voting power of all validators |
| consensus_byzantine_validators | Gauge | Number of validators who tried to double sign | | consensus_missing_validators | Gauge | 0.20.1 | Number of validators who did not sign |
| consensus_byzantine_validators_power | Gauge | Total voting power of the byzantine validators | | consensus_missing_validators_power | Gauge | 0.20.1 | Total voting power of the missing validators |
| consensus_block_interval | Timing | Time between this and last block (Block.Header.Time) | | consensus_byzantine_validators | Gauge | 0.20.1 | Number of validators who tried to double sign |
| consensus_rounds | Gauge | Number of rounds | | consensus_byzantine_validators_power | Gauge | 0.20.1 | Total voting power of the byzantine validators |
| consensus_num_txs | Gauge | Number of transactions | | consensus_block_interval_seconds | Histogram | 0.20.1 | Time between this and last block (Block.Header.Time) in seconds |
| mempool_size | Gauge | Number of uncommitted transactions | | consensus_rounds | Gauge | 0.20.1 | Number of rounds |
| consensus_total_txs | Gauge | Total number of transactions committed | | consensus_num_txs | Gauge | 0.20.1 | Number of transactions |
| consensus_block_size | Gauge | Block size in bytes | | mempool_size | Gauge | 0.20.1 | Number of uncommitted transactions |
| p2p_peers | Gauge | Number of peers node's connected to | | consensus_total_txs | Gauge | 0.20.1 | Total number of transactions committed |
| consensus_block_size_bytes | Gauge | 0.20.1 | Block size in bytes |
| p2p_peers | Gauge | 0.20.1 | Number of peers node's connected to |
## Useful queries ## Useful queries