26741944b1
## Issue Addressed NA ## Proposed Changes - Adds a HTTP server to the VC which provides Prometheus metrics. - Moves the health metrics into the `lighthouse_metrics` crate so it can be shared between BN/VC. - Sprinkle some metrics around the VC. - Update the book to indicate that we now have VC metrics. - Shifts the "waiting for genesis" logic later in the `ProductionValidatorClient::new_from_cli` - This is worth attention during the review. ## Additional Info - ~~`clippy` has some new lints that are failing. I'll deal with that in another PR.~~
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# Prometheus Metrics
|
|
|
|
Lighthouse provides an extensive suite of metrics and monitoring in the
|
|
[Prometheus](https://prometheus.io/docs/introduction/overview/) export format
|
|
via a HTTP server built into Lighthouse.
|
|
|
|
These metrics are generally consumed by a Prometheus server and displayed via a
|
|
Grafana dashboard. These components are available in a docker-compose format at
|
|
[sigp/lighthouse-metrics](https://github.com/sigp/lighthouse-metrics).
|
|
|
|
## Beacon Node Metrics
|
|
|
|
By default, these metrics are disabled but can be enabled with the `--metrics`
|
|
flag. Use the `--metrics-address`, `--metrics-port` and
|
|
`--metrics-allow-origin` flags to customize the metrics server.
|
|
|
|
### Example
|
|
|
|
Start a beacon node with the metrics server enabled:
|
|
|
|
```bash
|
|
lighthouse bn --metrics
|
|
```
|
|
|
|
Check to ensure that the metrics are available on the default port:
|
|
|
|
```bash
|
|
curl localhost:5054/metrics
|
|
```
|
|
|
|
## Validator Client Metrics
|
|
|
|
|
|
By default, these metrics are disabled but can be enabled with the `--metrics`
|
|
flag. Use the `--metrics-address`, `--metrics-port` and
|
|
`--metrics-allow-origin` flags to customize the metrics server.
|
|
|
|
### Example
|
|
|
|
Start a validator client with the metrics server enabled:
|
|
|
|
```bash
|
|
lighthouse vc --metrics
|
|
```
|
|
|
|
Check to ensure that the metrics are available on the default port:
|
|
|
|
```bash
|
|
curl localhost:5064/metrics
|
|
```
|