Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add metrics configuration #468

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

docs: add metrics configuration #468

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5088e5e
docs: add metrics configuration
tuxcanfly Sep 27, 2024
28d7929
docs: rollkit metrics
tuxcanfly Oct 11, 2024
1d0be7b
docs: centralized sequencer page
tuxcanfly Oct 11, 2024
6929da5
docs: centralized sequencer metrics
tuxcanfly Oct 11, 2024
197784d
docs: typo
tuxcanfly Oct 22, 2024
e5b6686
docs: clarify config file; rewrite
tuxcanfly Oct 22, 2024
f83123e
doc: review
tuxcanfly Oct 22, 2024
d282848
docs: add to menu
tuxcanfly Oct 22, 2024
3c244c5
docs: sidebar; heading
tuxcanfly Oct 22, 2024
bda8ad5
docs: fix config file path
tuxcanfly Oct 22, 2024
e485549
docs: centralized sequencer metrics
tuxcanfly Oct 22, 2024
23a2f24
docs: centralized-sequencer fmt
tuxcanfly Oct 22, 2024
0904c55
docs: centralized sequencer flags
tuxcanfly Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions guides/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# How to configure metrics

# 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
config file. Metrics will be served under `/metrics` on 26660 port by default.
tuxcanfly marked this conversation as resolved.
Show resolved Hide resolved
Listen address can be changed in the config file (see
`instrumentation.prometheus\_listen\_addr`).

## List of available metrics

The following metrics are available:

tuxcanfly marked this conversation as resolved.
Show resolved Hide resolved
| **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 |
| consensus\_step\_duration | Histogram | step | Histogram of durations for each step in the consensus protocol |
| consensus\_block\_gossip\_parts\_received | Counter | matches\_current | Number of block parts received by the node |
| 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 |
tuxcanfly marked this conversation as resolved.
Show resolved Hide resolved
31 changes: 31 additions & 0 deletions learn/centralized-sequencer-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### Centralized Sequencer Node

The `centralized-sequencer` node implements a pluggable centralized sequencer scheme.


| Flag | Usage | Default |
| ---------------------------- |-----------------------------------------|-----------------------------|
| `batch-time` | time in seconds to wait before generating a new batch | 2 seconds |
| `da_address` | DA address | `http:////localhost:26658`|
| `da_auth_token` | auth token for the DA | `""` |
| `da_namespace` | DA namespace where the sequencer submits transactions | `""` |
| `host` | centralized sequencer host | localhost |
| `port` | centralized sequencer port | 50051 |
| `listen-all` |listen on all network interfaces (0.0.0.0) instead of just localhost|disabled|
| `metrics` |enable prometheus metrics|disabled|
| `metrics-address` |address to expose prometheus metrics|`":8080"`|

tuxcanfly marked this conversation as resolved.
Show resolved Hide resolved
See `centralized-sequencer --help` for details.

The `centralized-sequencer` node reports prometheus metrics when the `-metrics` flag is enabled. By default metrics are exported to `http://localhost:8080/metrics`,
the listen address and port can be configured with `-metrics-address`

tuxcanfly marked this conversation as resolved.
Show resolved Hide resolved
The following metrics are available:

| **Name** | **Type** | **Tags** | **Description** |
|--------------------------------------------|-----------|------------------|------------------------------------------------------------------------|
| gas_price | Gauge | | Gas Price of the DA transaction |
| last_blob_size | Gauge | | Last blob size submitted to the DA |
| transaction_status | Gauge | | Transaction status of the DA transaction |
| num_pending_blocks | Gauge | | Number of blocks pending DA submission |
| included_block_height | Gauge | | Block height of the last DA transaction |