From 69d941ea3fcd50addc2c9affa93a0a257e712454 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:13:31 -0500 Subject: [PATCH] docs: Fix metrics name rendering (backport #9695) (#9804) * docs: Fix metrics name rendering (#9695) The docs theme unfortunately wraps code blocks inside tables, breaking the names and making them somewhat unreadable. This removes all the backticks from the metric names and tags. --- #### PR checklist - [x] Tests written/updated, or no tests needed - [x] `CHANGELOG_PENDING.md` updated, or no changelog entry needed - [x] Updated relevant documentation (`docs/`) and code comments, or no documentation updates needed (cherry picked from commit 17c94bb0dcb354c57f49cdcd1e62f4742752c803) # Conflicts: # docs/tendermint-core/metrics.md * Resolve conflicts Signed-off-by: Thane Thomson Signed-off-by: Thane Thomson Co-authored-by: Thane Thomson --- docs/tendermint-core/metrics.md | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/tendermint-core/metrics.md b/docs/tendermint-core/metrics.md index 245b32cdc..50876525e 100644 --- a/docs/tendermint-core/metrics.md +++ b/docs/tendermint-core/metrics.md @@ -18,40 +18,40 @@ Listen address can be changed in the config file (see The following metrics are available: -| **Name** | **Type** | **Tags** | **Description** | -|------------------------------------------|-----------|-------------------|------------------------------------------------------------------------| -| `consensus_height` | Gauge | | Height of the chain | -| `consensus_validators` | Gauge | | Number of validators | -| `consensus_validators_power` | Gauge | | Total voting power of all validators | -| `consensus_validator_power` | Gauge | | Voting power of the node if in the validator set | -| `consensus_validator_last_signed_height` | Gauge | | Last height the node signed a block, if the node is a validator | -| `consensus_validator_missed_blocks` | Gauge | | Total amount of blocks missed for the node, if the node is a validator | -| `consensus_missing_validators` | Gauge | | Number of validators who did not sign | -| `consensus_missing_validators_power` | Gauge | | Total voting power of the missing validators | -| `consensus_byzantine_validators` | Gauge | | Number of validators who tried to double sign | -| `consensus_byzantine_validators_power` | Gauge | | Total voting power of the byzantine validators | -| `consensus_block_interval_seconds` | Histogram | | Time between this and last block (Block.Header.Time) in seconds | -| `consensus_rounds` | Gauge | | Number of rounds | -| `consensus_num_txs` | Gauge | | Number of transactions | -| `consensus_total_txs` | Gauge | | Total number of transactions committed | -| `consensus_block_parts` | Counter | `peer_id` | Number of blockparts transmitted by peer | -| `consensus_latest_block_height` | Gauge | | /status sync\_info number | -| `consensus_fast_syncing` | Gauge | | Either 0 (not fast syncing) or 1 (syncing) | -| `consensus_state_syncing` | Gauge | | Either 0 (not state syncing) or 1 (syncing) | -| `consensus_block_size_bytes` | Gauge | | Block size in bytes | -| `p2p_message_send_bytes_total` | Counter | `message_type` | Number of bytes sent to all peers per message type | -| `p2p_message_receive_bytes_total` | Counter | `message_type` | Number of bytes received from all peers per message type | -| `p2p_peers` | Gauge | | Number of peers node's connected to | -| `p2p_peer_receive_bytes_total` | Counter | `peer_id`, `chID` | Number of bytes per channel received from a given peer | -| `p2p_peer_send_bytes_total` | Counter | `peer_id`, `chID` | Number of bytes per channel sent to a given peer | -| `p2p_peer_pending_send_bytes` | Gauge | `peer_id` | Number of pending bytes to be sent to a given peer | -| `p2p_num_txs` | Gauge | `peer_id` | Number of transactions submitted by each peer\_id | -| `p2p_pending_send_bytes` | Gauge | `peer_id` | Amount of data pending to be sent to peer | -| `mempool_size` | Gauge | | Number of uncommitted transactions | -| `mempool_tx_size_bytes` | Histogram | | Transaction sizes in bytes | -| `mempool_failed_txs` | Counter | | Number of failed transactions | -| `mempool_recheck_times` | Counter | | Number of transactions rechecked in the mempool | -| `state_block_processing_time` | Histogram | | Time between BeginBlock and EndBlock in ms | +| **Name** | **Type** | **Tags** | **Description** | +|--------------------------------------------|-----------|----------------|------------------------------------------------------------------------| +| consensus\_height | Gauge | | Height of the chain | +| consensus\_validators | Gauge | | Number of validators | +| consensus\_validators\_power | Gauge | | Total voting power of all validators | +| consensus\_validator\_power | Gauge | | Voting power of the node if in the validator set | +| consensus\_validator\_last\_signed\_height | Gauge | | Last height the node signed a block, if the node is a validator | +| consensus\_validator\_missed\_blocks | Gauge | | Total amount of blocks missed for the node, if the node is a validator | +| consensus\_missing\_validators | Gauge | | Number of validators who did not sign | +| consensus\_missing\_validators\_power | Gauge | | Total voting power of the missing validators | +| consensus\_byzantine\_validators | Gauge | | Number of validators who tried to double sign | +| consensus\_byzantine\_validators\_power | Gauge | | Total voting power of the byzantine validators | +| consensus\_block\_interval\_seconds | Histogram | | Time between this and last block (Block.Header.Time) in seconds | +| consensus\_rounds | Gauge | | Number of rounds | +| consensus\_num\_txs | Gauge | | Number of transactions | +| consensus\_total\_txs | Gauge | | Total number of transactions committed | +| consensus\_block\_parts | Counter | peer\_id | Number of blockparts transmitted by peer | +| consensus\_latest\_block\_height | Gauge | | /status sync\_info number | +| consensus\_fast\_syncing | Gauge | | Either 0 (not fast syncing) or 1 (syncing) | +| consensus\_state\_syncing | Gauge | | Either 0 (not state syncing) or 1 (syncing) | +| consensus\_block\_size\_bytes | Gauge | | Block size in bytes | +| p2p\_message\_send\_bytes\_total | Counter | message\_type | Number of bytes sent to all peers per message type | +| p2p\_message\_receive\_bytes\_total | Counter | message\_type | Number of bytes received from all peers per message type | +| p2p\_peers | Gauge | | Number of peers node's connected to | +| p2p\_peer\_receive\_bytes\_total | Counter | peer\_id, chID | Number of bytes per channel received from a given peer | +| p2p\_peer\_send\_bytes\_total | Counter | peer\_id, chID | Number of bytes per channel sent to a given peer | +| p2p\_peer\_pending\_send\_bytes | Gauge | peer\_id | Number of pending bytes to be sent to a given peer | +| p2p\_num\_txs | Gauge | peer\_id | Number of transactions submitted by each peer\_id | +| p2p\_pending\_send\_bytes | Gauge | peer\_id | Amount of data pending to be sent to peer | +| mempool\_size | Gauge | | Number of uncommitted transactions | +| mempool\_tx\_size\_bytes | Histogram | | Transaction sizes in bytes | +| mempool\_failed\_txs | Counter | | Number of failed transactions | +| mempool\_recheck\_times | Counter | | Number of transactions rechecked in the mempool | +| state\_block\_processing\_time | Histogram | | Time between BeginBlock and EndBlock in ms | ## Useful queries