From 8e8d50995879bb7c495ac8ab0c833ceca7728e94 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sat, 8 May 2021 13:01:04 +0200 Subject: [PATCH] add documentation how to access pull-through proxy stats Signed-off-by: Robert Kaussow --- docs/configuration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 1bec821e..a464e606 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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. +>**NONE**: 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 |