Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 committed Aug 7, 2024
1 parent 07e39a1 commit e307132
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions server/docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,11 @@ All classes that need to observe metrics can get them from the BlockNodeContext.
If a new metric is needed, it can be added to MetricsService, and then used in the classes that need it. This is to avoid having to define the metrics in several places.
MetricsService centralizes the creation of metrics and provides a way to access them from any other class.

To check the metrics you can access the Prometheus endpoint at `http://localhost:9999/metrics`.

## Existing Metrics

| Metric Name | Description | Type |
|----------------|---------------------------|---------|
| exampleGauge | An example gauge metric | Gauge |
| exampleCounter | An example counter metric | Counter |

0 comments on commit e307132

Please sign in to comment.