github/reth
1
1
Fork 0
mirror of https://github.com/paradigmxyz/reth.git synced 2026-01-10 07:48:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update metrics.md (#14813)

Browse Source
This commit is contained in:
Jennifer
2025-03-11 17:36:16 +01:00
committed by GitHub
parent e5615d0d9d
commit 5fba223bad
2 changed files with 11 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
book/run/observability.md
View File

@@ -1,6 +1,6 @@
# Observability with Prometheus & Grafana
Reth exposes a number of metrics, which are listed [here][metrics]. We can serve them from an HTTP endpoint by adding the `--metrics` flag:
Reth exposes a number of metrics which can be enabled by adding the `--metrics` flag:
```bash
reth node --metrics 127.0.0.1:9001
@@ -24,7 +24,7 @@ We're finally getting somewhere! As a final step, though, wouldn't it be great t
## Prometheus & Grafana
We're going to be using Prometheus to collect metrics off of the endpoint we set up, and use Grafana to scrape the metrics from Prometheus and define a dashboard with them.
We're going to use Prometheus to scrape the metrics from our node, and use Grafana to on a dashboard.
Let's begin by installing both Prometheus and Grafana, which one can do with e.g. Homebrew:

47
docs/design/metrics.md
View File

@@ -1,6 +1,8 @@
## Metrics
### Metrics or traces?
Reth exposes a number of metrics, which can be served from an HTTP endpoint by adding the `--metrics` flag.
### Metrics vs traces
A **metric** is a numeric representation of data measured over intervals of time. Metrics are malleable to statistical transformations such as sampling, aggregation and correlation, which make them suited to report the overall health of a system.
@@ -61,44 +63,13 @@ How the metrics are exposed to the end-user is determined by the CLI.
[^1]: The top-level namespace is added by the CLI using [`metrics_util::layers::PrefixLayer`][metrics_util.PrefixLayer].
### Current metrics
### Example metrics
- [Transcation Pool Metrics](../../crates/transaction-pool/src/metrics.rs)
- [Network Metrics](../../crates/net/network/src/metrics.rs)
- [Header Downloader Metrics](../../crates/net/downloaders/src/metrics.rs)
This list may be non-exhaustive.
#### Stage: Headers
- `stages.headers.counter`: Number of headers successfully retrieved
- `stages.headers.timeout_error`: Number of timeout errors while requesting headers
- `stages.headers.validation_errors`: Number of validation errors while requesting headers
- `stages.headers.unexpected_errors`: Number of unexpected errors while requesting headers
- `stages.headers.request_time`: Elapsed time of successful header requests
#### Component: Transaction Pool
- `transaction_pool.inserted_transactions`: Number of transactions inserted in the pool
- `transaction_pool.invalid_transactions`: Number of invalid transactions
- `transaction_pool.removed_transactions`: Number of removed transactions from the pool
- `transaction_pool.pending_pool_transactions`: Number of transactions in the pending sub-pool
- `transaction_pool.pending_pool_size_bytes`: Total amount of memory used by the transactions in the pending sub-pool in bytes
- `transaction_pool.basefee_pool_transactions`: Number of transactions in the basefee sub-pool
- `transaction_pool.basefee_pool_size_bytes`: Total amount of memory used by the transactions in the basefee sub-pool in bytes
- `transaction_pool.queued_pool_transactions`: Number of transactions in the queued sub-pool
- `transaction_pool.queued_pool_size_bytes`: Total amount of memory used by the transactions in the queued sub-pool in bytes
- `transaction_pool.blob_pool_transactions`: Number of transactions in the blob sub-pool
- `transaction_pool.blob_pool_size_bytes`: Total amount of memory used by the transactions in the blob sub-pool in bytes
#### Component: Network
- `network.connected_peers`: Number of currently connected peers
- `network.tracked_peers`: Number of peers known to the node
- `network.pending_session_failures`: Cumulative number of failures of pending sessions
- `network.closed_sessions`: Total number of sessions closed
- `network.incoming_connections`: Number of active incoming connections
- `network.outgoing_connections`: Number of active outgoing connections
- `network.total_incoming_connections`: Total number of incoming connections handled
- `network.total_outgoing_connections`: Total number of outgoing connections established
- `network.invalid_messages_received`: Number of invalid/malformed messages received from peers
- `network.propagated_transactions`: Total number of propagated transactions
### Metrics Dashboards
- [Grafana Dashboards](../../etc/grafana/dashboards)
[metrics]: https://docs.rs/metrics
[metrics.Key]: https://docs.rs/metrics/latest/metrics/struct.Key.html