Skip to content

Commit

Permalink
docs: add more information about enabling metrics
Browse files Browse the repository at this point in the history
Signed-off-by: Bin Tang <[email protected]>
  • Loading branch information
sctb512 committed Jul 13, 2023
1 parent 0266ac1 commit ee5d97f
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/configure_nydus.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ The Nydus snapshotter will get the new secret and parse the authorization. If yo
## Metrics

Nydusd records metrics in its own format. The metrics are exported via a HTTP server on top of unix domain socket. Nydus-snapshotter fetches the metrics and convert them in to Prometheus format which is exported via a network address. Nydus-snapshotter by default does not fetch metrics from nydusd. You can enable the nydusd metrics download by assigning an network address to `metrics.address` in nydus-snapshotter's toml [configuration file](../misc/snapshotter/config.toml).
Once this entry is enabled, not only nydusd metrics, but also some information about the nydus-snapshotter
runtime and snapshot related events are exported in Prometheus format as well.

## Diagnose

Expand Down

0 comments on commit ee5d97f

Please sign in to comment.