dkirillov/distribution
1
0
Fork 0
forked from TrueCloudLab/distribution
Code Pull requests Activity

add documentation how to access pull-through proxy stats

Browse source 
Signed-off-by: Robert Kaussow <mail@geeklabor.de>
This commit is contained in:
Robert Kaussow 2021-05-08 13:01:04 +02:00
parent 9329f6a62b
commit 8e8d509958
No known key found for this signature in database
GPG key ID: 65362AE74AF98B61
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/configuration.md
View file

@ -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 `debug` section takes a single required `addr` parameter, which specifies
the `HOST:PORT` on which the debug server should accept connections. 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` ## `prometheus`
The `prometheus` option defines whether the prometheus metrics is enable, as well The `prometheus` option defines whether the prometheus metrics is enable, as well
as the path to access the metrics. as the path to access the metrics.
>**NONE**: The prometheus metrics do **not** cover pull-through cache statistics.
> Proxy statistics are exposed via `expvar` only.
| Parameter | Required | Description | | Parameter | Required | Description |
|-----------|----------|-------------------------------------------------------| |-----------|----------|-------------------------------------------------------|
| `enabled` | no | Set `true` to enable the prometheus server | | `enabled` | no | Set `true` to enable the prometheus server |