From 569459306c4e34e549a8eb71b4979b8c77b80bc5 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 1 Aug 2025 16:55:36 -0500 Subject: [PATCH 1/4] DOC-5462 Added basic hardware requirements and Docker install step to monitoring RS with Prometheus and Grafana quickstart --- .../rs-prometheus-grafana-quickstart.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index f8472750da..694c8b4441 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -21,8 +21,36 @@ Redis Enterprise version 7.8.2 introduces a preview of the new metrics stream en ## Quick start +### Hardware requirements + +The minimum hardware requirements to set up Redis Enterprise Software monitoring in production using Prometheus, Grafana, and the metrics stream engine are: + +- **CPU**: 4 vCPUs +- **Memory**: 8-12 GB RAM +- **Storage**: 100 GB SSD + +You should also consider the following to determine your deployment's hardware requirements: + +- The number of Redis instances being scraped. + +- Lower scrape intervals, such as 15 seconds versus 1 minute, increase resource usage. The Redis scraping interval is 30 seconds. + +- Longer retention increases storage requirements. Basic retention is 90 days. + +- For high availability, run Prometheus in a replicated or federated mode for redundancy, and use Grafana’s load balancing for multiple users. + +- Factor in overhead if Prometheus is writing metrics to remote storage such as Thanos or Cortex. + +- Ensure high disk IOPS for Prometheus TSDB for better write and read performance. + +For more details about Grafana hardware requirements, see the [offical Grafana documentation](https://grafana.com/docs/enterprise-traces/latest/setup/hardware-requirements/). + +### Setup steps + To get started with Prometheus and Grafana: +1. Install Docker on your system. For installation instructions, see the [official Docker documentation](https://docs.docker.com/get-started/get-docker/). + 1. Create a directory called 'prometheus' on your local machine. 1. Within that directory, create a configuration file called `prometheus.yml`. From 51c6565103749b7913b8fb19090534ffed8a6f86 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 14 Aug 2025 11:31:06 -0500 Subject: [PATCH 2/4] DOC-5462 Added Prometheus and Grafana persistent storage setup to docker-compose config file --- content/embeds/rs-prometheus-grafana-quickstart.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index 694c8b4441..f9a3a1e6be 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -110,6 +110,8 @@ We recommend running Prometheus in Docker only for development and testing. - 9090:9090 volumes: - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml + # Persistent storage for Prometheus + - prometheus-data:/prometheus grafana-ui: image: grafana/grafana @@ -117,8 +119,17 @@ We recommend running Prometheus in Docker only for development and testing. - 3000:3000 environment: - GF_SECURITY_ADMIN_PASSWORD=secret + volumes: + # Persistent storage for Grafana + - grafana-storage:/var/lib/grafana links: - prometheus-server:prometheus + + # Define Docker-managed volumes for persistent storage + # These volumes are created automatically and persist data between container restarts + volumes: + prometheus-data: + grafana-storage: ``` 1. To start the containers, run: From 8af1ef8701e0d490539765a25de21f98b4de3510 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 2 Apr 2026 15:51:20 -0500 Subject: [PATCH 3/4] DOC-5462 Added additional resource links to Prometheus and Grafana quick start for instllation and config help and setting up alerts --- .../rs-prometheus-grafana-quickstart.md | 29 +++++++++++++++++-- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index 61f0d4328e..511a58a5bd 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -132,7 +132,7 @@ scrape_configs: ``` {{< /multitabs >}} -1. Set up your Prometheus and Grafana servers. +1. Set up your Prometheus and Grafana servers. See the official [Prometheus installation](https://prometheus.io/docs/prometheus/latest/installation/) and [Grafana installation](https://grafana.com/docs/grafana/latest/setup-grafana/installation/) documentation for help. {{< note >}} @@ -140,7 +140,8 @@ We recommend running Prometheus in Docker only for development and testing. {{< /note >}} - To set up Prometheus and Grafana on Docker: + To set up Prometheus and Grafana on Docker, follow these steps. For additional help, see the official [Prometheus](https://prometheus.io/docs/prometheus/latest/installation/#using-docker) and [Grafana](https://grafana.com/docs/grafana/latest/setup-grafana/installation/docker/) Docker image documentation. + 1. Create a _docker-compose.yml_ file: ```yml @@ -227,7 +228,29 @@ We recommend running Prometheus in Docker only for development and testing. To add preconfigured dashboards: 1. In the Grafana dashboards menu, select **Manage**. 1. Click **Import**. - 1. Upload one or more [Grafana dashboards](#grafana-dashboards-for-redis-enterprise). + 1. Upload one or more [Grafana dashboards](#grafana-dashboards-for-redis-software). + +1. To set up alerts in Prometheus or Grafana, see the following resources: + + - [Official Prometheus alerting documentation](https://prometheus.io/docs/alerting/latest/overview/) + + - For v1 metrics alerts: + + - [Configuring Prometheus + for v1 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus#readme) + + - [Example Prometheus alert rules for v1 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus/rules/alerts.yml) + + - For v2 metrics alerts: + + - [Configuring Prometheus + for v2 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus_v2#readme) + + - [Example Prometheus alert rules for v2 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/alerts.yml) + + - [Tutorial on how to set up alerting for Redis](https://redis.io/tutorials/operate/observability/redis-software-prometheus-and-grafana/#how-do-you-set-up-alerting-for-redis) + + - [Official Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) ## Grafana dashboards for Redis Software From 903eb353f78c6862e149b7a413ec838d28ea5ed9 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Wed, 27 May 2026 09:56:04 -0500 Subject: [PATCH 4/4] DOC-5462 Feedback updates to collapse v1 metrics references and mark them as deprecated --- .../rs-prometheus-grafana-quickstart.md | 60 ++++++++++++------- .../release-notes/rs-8-0-releases/_index.md | 2 +- .../rs-8-0-releases/rs-8-0-2-17.md | 4 +- 3 files changed, 40 insertions(+), 26 deletions(-) diff --git a/content/embeds/rs-prometheus-grafana-quickstart.md b/content/embeds/rs-prometheus-grafana-quickstart.md index 511a58a5bd..dc0fed8e8c 100644 --- a/content/embeds/rs-prometheus-grafana-quickstart.md +++ b/content/embeds/rs-prometheus-grafana-quickstart.md @@ -57,7 +57,7 @@ To get started with Prometheus and Grafana: {{< multitabs id="prometheus-config-yml" tab1="v2 (metrics stream engine)" -tab2="v1" >}} +tab2="v1 (deprecated)" >}} ```yml global: @@ -232,25 +232,35 @@ We recommend running Prometheus in Docker only for development and testing. 1. To set up alerts in Prometheus or Grafana, see the following resources: - - [Official Prometheus alerting documentation](https://prometheus.io/docs/alerting/latest/overview/) + {{< multitabs id="metrics-alerts" +tab1="v2 (metrics stream engine)" +tab2="v1 (deprecated)" >}} + +For v2 metrics alerts: - - For v1 metrics alerts: +- [Official Prometheus alerting documentation](https://prometheus.io/docs/alerting/latest/overview/) - - [Configuring Prometheus - for v1 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus#readme) +- [Configuring Prometheus for v2 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus_v2#readme) - - [Example Prometheus alert rules for v1 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus/rules/alerts.yml) +- [Example Prometheus alert rules for v2 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/alerts.yml) + +- [Tutorial on how to set up alerting for Redis](https://redis.io/tutorials/operate/observability/redis-software-prometheus-and-grafana/#how-do-you-set-up-alerting-for-redis) + +- [Official Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) + +-tab-sep- + +For v1 metrics alerts: - - For v2 metrics alerts: +- [Official Prometheus alerting documentation](https://prometheus.io/docs/alerting/latest/overview/) - - [Configuring Prometheus - for v2 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus_v2#readme) +- [Configuring Prometheus for v1 metrics alerts](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus#readme) - - [Example Prometheus alert rules for v2 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/alerts.yml) +- [Example Prometheus alert rules for v1 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus/rules/alerts.yml) - - [Tutorial on how to set up alerting for Redis](https://redis.io/tutorials/operate/observability/redis-software-prometheus-and-grafana/#how-do-you-set-up-alerting-for-redis) +- [Official Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) - - [Official Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) +{{< /multitabs >}} ## Grafana dashboards for Redis Software @@ -264,17 +274,9 @@ These dashboards are open source. For additional dashboard options, or to file a For more information about configuring Grafana dashboards, see the [Grafana documentation](https://grafana.com/docs/). -### V1 metrics dashboards - -Use the following dashboards when connecting to the v1 metrics endpoint (`https://:8070/`): - -* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Software clusters. -* The [database status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-database-dashboard_v9-11.json) displays specific database metrics, including latency, memory usage, ops/second, and key count. -* The [node metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json) provides metrics for each of the nodes hosting your cluster. -* The [shard metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-shard-dashboard_v9-11.json) displays metrics for the individual Redis processes running on your cluster nodes. -* The [Active-Active dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json) displays metrics specific to [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}). - -### V2 metrics dashboards +{{< multitabs id="metrics-dashboards" +tab1="v2 (metrics stream engine)" +tab2="v1 (deprecated)" >}} Use the following dashboards when connecting to the v2 metrics endpoint (`https://:8070/v2`): @@ -285,3 +287,15 @@ Use the following dashboards when connecting to the v2 metrics endpoint (`https: * The [Active-Active dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json) displays metrics specific to [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}). * The [QPS dashboard - Redis Search metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/dashboards/grafana_v9-11/search/RediSearchQPS.json) displays metrics specific to Redis Search, showcasing QPS, Query Latency, Indexing performance, and more. * The [OPS dashboards](https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana_v2/dashboards/grafana_v9-11/software/ops) are advanced operational dashboards for on-premises deployments. + +-tab-sep- + +Use the following dashboards when connecting to the v1 metrics endpoint (`https://:8070/`): + +* The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json) provides an overview of your Redis Software clusters. +* The [database status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-database-dashboard_v9-11.json) displays specific database metrics, including latency, memory usage, ops/second, and key count. +* The [node metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json) provides metrics for each of the nodes hosting your cluster. +* The [shard metrics dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-shard-dashboard_v9-11.json) displays metrics for the individual Redis processes running on your cluster nodes. +* The [Active-Active dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json) displays metrics specific to [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}). + +{{< /multitabs >}} diff --git a/content/operate/rs/release-notes/rs-8-0-releases/_index.md b/content/operate/rs/release-notes/rs-8-0-releases/_index.md index 83a528ad4b..e61ee9da26 100644 --- a/content/operate/rs/release-notes/rs-8-0-releases/_index.md +++ b/content/operate/rs/release-notes/rs-8-0-releases/_index.md @@ -173,7 +173,7 @@ See [Ports and port ranges used by Redis Software]({{}}) is deprecated. We recommend transitioning to the new [metrics stream engine]({{}}) for improved performance, enhanced integration capabilities, and modernized metrics streaming. -V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). +V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). As part of the transition to the metrics stream engine, some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{}}) for guidance. diff --git a/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md b/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md index c27fcb449b..f183ca508e 100644 --- a/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md +++ b/content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-2-17.md @@ -158,7 +158,7 @@ The [metrics stream engine]({{}}). -- To transition to the metrics stream engine, either migrate your existing dashboards using [Prometheus v1 metrics and equivalent v2 PromQL]({{}}) or use [new preconfigured dashboards]({{}}). +- To transition to the metrics stream engine, either migrate your existing dashboards using [Prometheus v1 metrics and equivalent v2 PromQL]({{}}) or use [new preconfigured dashboards]({{}}). - As part of the transition to the metrics stream engine, some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{}}) for guidance. @@ -464,7 +464,7 @@ See [Ports and port ranges used by Redis Software]({{}}) is deprecated. We recommend transitioning to the new [metrics stream engine]({{}}) for improved performance, enhanced integration capabilities, and modernized metrics streaming. -V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). +V1 Prometheus metrics are deprecated but still available. To transition to the new metrics stream engine, either migrate your existing dashboards using [this guide]({{}}) or use [new preconfigured dashboards]({{}}). As part of the transition to the metrics stream engine, some internal cluster manager alerts were deprecated in favor of external monitoring solutions. See the [alerts transition plan]({{}}) for guidance.