docs: warn against enabling Prometheus metrics if not in use (#26560)

The go-metrics library retains Prometheus metrics in memory until expiration,
but the expiration logic requires that the metrics are being regularly
scraped. If you don't have a Prometheus server scraping, this leads to
ever-increasing memory usage. In particular, high volume dispatch workloads emit
a large set of label values and if these are not eventually aged out the bulk of
Nomad server memory can end up consumed by metrics.
This commit is contained in:
Tim Gross
2025-08-19 08:44:16 -04:00
committed by GitHub
parent d13abe376c
commit b8b95eb918

View File

@@ -149,8 +149,10 @@ telemetry {
These `telemetry` parameters apply to [Prometheus].
- `prometheus_metrics` `(bool: false)` - Specifies whether the agent should
make Prometheus formatted metrics available at `/v1/metrics?format=prometheus`.
- `prometheus_metrics` `(bool: false)` - Specifies whether the agent should make
Prometheus formatted metrics available at `/v1/metrics?format=prometheus`.
Nomad's Prometheus client retains metrics in memory unless scraped, so you
should not enable this field unless you are collecting metrics via Promtheus.
### `circonus` (Apica)