-
Notifications
You must be signed in to change notification settings - Fork 780
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3cf0de3
commit a68171c
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Prometheus Metrics | ||
|
||
Lighthouse provides and 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` and `--metrics-port` flags to customize the | ||
listening socket of 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 | ||
|
||
The validator client does not *yet* expose metrics, however this functionality | ||
is expected to be implemented in late-September 2020. |