Skip to content

Commit

Permalink
Merge pull request distribution#3415 from xoxys/proxy-stats
Browse files Browse the repository at this point in the history
add documentation how to access pull-through proxy stats
  • Loading branch information
joaodrp authored May 13, 2021
2 parents f65a33d + 09334b5 commit c63b580
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -913,11 +913,17 @@ access to the debug endpoint is locked down in a production environment.
The `debug` section takes a single required `addr` parameter, which specifies
the `HOST:PORT` on which the debug server should accept connections.

If the registry is configured as a pull-through cache, the `debug` server can be used
to access proxy statistics. These statistics are exposed at `/debug/vars` in JSON format.

## `prometheus`

The `prometheus` option defines whether the prometheus metrics is enable, as well
as the path to access the metrics.

>**NOTE**: The prometheus metrics do **not** cover pull-through cache statistics.
> Proxy statistics are exposed via `expvar` only.
| Parameter | Required | Description |
|-----------|----------|-------------------------------------------------------|
| `enabled` | no | Set `true` to enable the prometheus server |
Expand Down

0 comments on commit c63b580

Please sign in to comment.