From 8afdb70ce0dcb6d88a00187310049227409da96d Mon Sep 17 00:00:00 2001 From: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> Date: Fri, 9 Jan 2026 17:11:35 +0100 Subject: [PATCH] docs(consoles): Add Prometheus 3.0 deprecation warnings and update links Add warning blocks to console documentation explaining that console templates and libraries are no longer bundled with Prometheus 3.0 and must be provided by users via command-line flags. Update GitHub links to reference release-2.55 branch instead of main, noting that 2.x console libraries are unmaintained and contain known CVEs Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> --- docs/practices/consoles.md | 2 ++ docs/visualization/consoles.md | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/practices/consoles.md b/docs/practices/consoles.md index bb5d47a6..5b4f6dbf 100644 --- a/docs/practices/consoles.md +++ b/docs/practices/consoles.md @@ -3,6 +3,8 @@ title: Consoles and dashboards sort_rank: 3 --- +CAUTION: Starting with Prometheus 3.0, console templates and libraries are no longer bundled with Prometheus. If you wish to use console templates, you must provide your own templates and libraries by specifying the `--web.console.templates` and `--web.console.libraries` command-line flags. This documentation page is maintained for historical reference and to demonstrate the capabilities of console templates. Please be aware that any referenced console libraries from the Prometheus 2.x branch are no longer maintained and may contain known security vulnerabilities (CVEs). + It can be tempting to display as much data as possible on a dashboard, especially when a system like Prometheus offers the ability to have such rich instrumentation of your applications. This can lead to consoles that are diff --git a/docs/visualization/consoles.md b/docs/visualization/consoles.md index 5b8e14f6..2e0c2e0e 100644 --- a/docs/visualization/consoles.md +++ b/docs/visualization/consoles.md @@ -3,6 +3,8 @@ title: Console templates sort_rank: 4 --- +CAUTION: Starting with Prometheus 3.0, console templates and libraries are no longer bundled with Prometheus. If you wish to use console templates, you must provide your own templates and libraries by specifying the `--web.console.templates` and `--web.console.libraries` command-line flags. This documentation page is maintained for historical reference and to demonstrate the capabilities of console templates. Please be aware that any referenced console libraries from the Prometheus 2.x branch are no longer maintained and may contain known security vulnerabilities (CVEs). + Console templates allow for creation of arbitrary consoles using the [Go templating language](http://golang.org/pkg/text/template/). These are served from the Prometheus server. @@ -121,7 +123,7 @@ Valid output formats for the third argument to `prom_query_drilldown`: * `printf.3g`: Display 3 significant digits. Custom formats can be defined. See -[prom.lib](https://github.com/prometheus/prometheus/blob/main/console_libraries/prom.lib) for examples. +[prom.lib](https://github.com/prometheus/prometheus/blob/release-2.55/console_libraries/prom.lib) for examples. ## Graph Library