From 679b58e7832dbbf894c2bca753514c75e664f6d9 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Mon, 29 Sep 2025 16:16:02 -0500 Subject: [PATCH] DOC-5774 RS: Clarify Prometheus config transition from v1 to v2 --- .../rs-prometheus-grafana-quickstart.md | 115 ++++++++++++------ .../prometheus-metrics-v1-to-v2.md | 24 +++- .../7.8/monitoring/metrics_stream_engine.md | 24 +++- .../metrics/prometheus-metrics-v1-to-v2.md | 24 +++- .../rs/monitoring/metrics_stream_engine.md | 24 +++- .../metrics/prometheus-metrics-v1-to-v2.md | 24 +++- 6 files changed, 194 insertions(+), 41 deletions(-) diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index f8472750da..a754b673db 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -28,48 +28,91 @@ To get started with Prometheus and Grafana: 1. Within that directory, create a configuration file called `prometheus.yml`. 1. Add the following contents to the configuration file and replace `` with your Redis Enterprise cluster's FQDN: + {{< multitabs id="prometheus-config-yml" +tab1="v2 (metrics stream engine)" +tab2="v1" >}} + +```yml +global: + scrape_interval: 15s + evaluation_interval: 15s + +# Attach these labels to any time series or alerts when communicating with +# external systems (federation, remote storage, Alertmanager). + external_labels: + monitor: "prometheus-stack-monitor" + +# Load and evaluate rules in this file every 'evaluation_interval' seconds. +#rule_files: +# - "first.rules" +# - "second.rules" + +scrape_configs: +# scrape Prometheus itself + - job_name: prometheus + scrape_interval: 10s + scrape_timeout: 5s + static_configs: + - targets: ["localhost:9090"] + +# scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + +-tab-sep- + +```yml +global: + scrape_interval: 15s + evaluation_interval: 15s + +# Attach these labels to any time series or alerts when communicating with +# external systems (federation, remote storage, Alertmanager). + external_labels: + monitor: "prometheus-stack-monitor" + +# Load and evaluate rules in this file every 'evaluation_interval' seconds. +#rule_files: +# - "first.rules" +# - "second.rules" + +scrape_configs: +# scrape Prometheus itself + - job_name: prometheus + scrape_interval: 10s + scrape_timeout: 5s + static_configs: + - targets: ["localhost:9090"] + +# scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: / + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + {{< /multitabs >}} + +1. Set up your Prometheus and Grafana servers. + {{< note >}} We recommend running Prometheus in Docker only for development and testing. {{< /note >}} - ```yml - global: - scrape_interval: 15s - evaluation_interval: 15s - - # Attach these labels to any time series or alerts when communicating with - # external systems (federation, remote storage, Alertmanager). - external_labels: - monitor: "prometheus-stack-monitor" - - # Load and evaluate rules in this file every 'evaluation_interval' seconds. - #rule_files: - # - "first.rules" - # - "second.rules" - - scrape_configs: - # scrape Prometheus itself - - job_name: prometheus - scrape_interval: 10s - scrape_timeout: 5s - static_configs: - - targets: ["localhost:9090"] - - # scrape Redis Enterprise - - job_name: redis-enterprise - scrape_interval: 30s - scrape_timeout: 30s - metrics_path: / # For v2, use /v2 - scheme: https - tls_config: - insecure_skip_verify: true - static_configs: - - targets: [":8070"] - ``` - -1. Set up your Prometheus and Grafana servers. To set up Prometheus and Grafana on Docker: 1. Create a _docker-compose.yml_ file: diff --git a/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2.md b/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2.md index 3c50929277..01393038b1 100644 --- a/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2.md +++ b/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2.md @@ -16,6 +16,28 @@ tocEmbedHeaders: true You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. -As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 PromQL metrics, see [Prometheus metrics v2]({{}}). +As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. + +To transition from v1 metrics to v2 metrics, you need to change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint. + +Here's an example of the updated scraping configuration in `prometheus.yml`: + +```yaml +scrape_configs: + # Scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + +It is possible to scrape both v1 and v2 endpoints simultaneously during the transition period to prepare dashboards and ensure a smooth transition. + +You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 PromQL metrics, see [Prometheus metrics v2]({{}}). {{}} diff --git a/content/operate/rs/7.8/monitoring/metrics_stream_engine.md b/content/operate/rs/7.8/monitoring/metrics_stream_engine.md index df414fb32c..cf423abee4 100644 --- a/content/operate/rs/7.8/monitoring/metrics_stream_engine.md +++ b/content/operate/rs/7.8/monitoring/metrics_stream_engine.md @@ -37,4 +37,26 @@ The v2 scraping endpoint also exposes metrics for `node_exporter` version 1.8.1. ## Transition from Prometheus v1 to Prometheus v2 -If you are already using the existing scraping endpoint for integration, follow [this guide]({{}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. +If you are already using the existing scraping endpoint for integration, do the following to transition from v1 metrics to v2 metrics: + +1. Change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint. + + Here's an example of the updated scraping configuration in `prometheus.yml`: + + ```yaml + scrape_configs: + # Scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] + ``` + +1. Use the metrics tables in [this guide]({{}}) to transition from v1 metrics to equivalent v2 PromQL. + +It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. diff --git a/content/operate/rs/7.8/references/metrics/prometheus-metrics-v1-to-v2.md b/content/operate/rs/7.8/references/metrics/prometheus-metrics-v1-to-v2.md index 0faeeb9946..a4d0000134 100644 --- a/content/operate/rs/7.8/references/metrics/prometheus-metrics-v1-to-v2.md +++ b/content/operate/rs/7.8/references/metrics/prometheus-metrics-v1-to-v2.md @@ -17,6 +17,28 @@ url: '/operate/rs/7.8/references/metrics/prometheus-metrics-v1-to-v2/' You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. -As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). +As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. + +To transition from v1 metrics to v2 metrics, you need to change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint. + +Here's an example of the updated scraping configuration in `prometheus.yml`: + +```yaml +scrape_configs: + # Scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + +It is possible to scrape both v1 and v2 endpoints simultaneously during the transition period to prepare dashboards and ensure a smooth transition. + +You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). {{}} diff --git a/content/operate/rs/monitoring/metrics_stream_engine.md b/content/operate/rs/monitoring/metrics_stream_engine.md index 096e55c01a..d257dd201a 100644 --- a/content/operate/rs/monitoring/metrics_stream_engine.md +++ b/content/operate/rs/monitoring/metrics_stream_engine.md @@ -36,4 +36,26 @@ The v2 scraping endpoint also exposes metrics for `node_exporter` version 1.8.1. ## Transition from Prometheus v1 to Prometheus v2 -If you are already using the existing scraping endpoint for integration, follow [this guide]({{}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. +If you are already using the existing scraping endpoint for integration, do the following to transition from v1 metrics to v2 metrics: + +1. Change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint. + + Here's an example of the updated scraping configuration in `prometheus.yml`: + + ```yaml + scrape_configs: + # Scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] + ``` + +1. Use the metrics tables in [this guide]({{}}) to transition from v1 metrics to equivalent v2 PromQL. + +It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. diff --git a/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md b/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md index 0dc8acfcb1..122e02eb0e 100644 --- a/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md +++ b/content/operate/rs/references/metrics/prometheus-metrics-v1-to-v2.md @@ -16,6 +16,28 @@ tocEmbedHeaders: true You can [integrate Redis Enterprise Software with Prometheus and Grafana]({{}}) to create dashboards for important metrics. -As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). +As of Redis Enterprise Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. + +To transition from v1 metrics to v2 metrics, you need to change the `metrics_path` in your Prometheus configuration file from `/` to `/v2` to use the new scraping endpoint. + +Here's an example of the updated scraping configuration in `prometheus.yml`: + +```yaml +scrape_configs: + # Scrape Redis Enterprise + - job_name: redis-enterprise + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: /v2 + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + - targets: [":8070"] +``` + +It is possible to scrape both v1 and v2 endpoints simultaneously during the transition period to prepare dashboards and ensure a smooth transition. + +You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). {{}}