# Prometheus and Grafana with Redis Software ```json metadata { "schema_version": 2, "title": "Prometheus and Grafana with Redis Software", "description": "Use Prometheus and Grafana to collect and visualize Redis Software metrics.", "categories": ["docs","integrate","rs"], "group": "observability", "tableOfContents": {"sections":[]} , "codeExamples": [] } ``` You can use Prometheus and Grafana to collect and visualize your Redis Software metrics. Metrics are exposed at the cluster, node, database, shard, and proxy levels. - [Prometheus](https://prometheus.io/) is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources. - [Grafana](https://grafana.com/) is an open source metrics visualization tool that processes Prometheus data. You can use Prometheus and Grafana to: - Collect and display metrics not available in the Cluster Manager UI - Set up automatic alerts for all resources - Display Redis Software metrics alongside data from other systems ![Graphic showing how Prometheus and Grafana collect and display data from a Redis Software Cluster. Prometheus collects metrics from the Redis Software cluster, and Grafana queries those metrics for visualization.](https://redis.io/docs/latest/images/rs/grafana-prometheus.png) To get started with Prometheus and Grafana, see the following [quick start](#quick-start) or see [Redis Software Observability with Prometheus and Grafana](https://redis.io/learn/operate/observability/redis-software-prometheus-and-grafana) for a more detailed tutorial. ## 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`. 1. Add the following contents to the configuration file and replace `` with your Redis Software cluster's FQDN: **v2 (metrics stream engine):** ```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 Software - 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"] ``` **v1 (deprecated):** ```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 Software - job_name: redis-enterprise scrape_interval: 30s scrape_timeout: 30s metrics_path: / scheme: https tls_config: insecure_skip_verify: true static_configs: - targets: [":8070"] ``` > [!NOTE] > **Use a single scrape target.** The v2 endpoint is cluster-wide. Every node aggregates metrics from all nodes and returns the same complete result, so one target is enough. If you list one target per node, Prometheus stores every series once per target and multiplies each `sum()`-based dashboard panel by the number of targets. This produces no error. Prometheus reports every target as up and Grafana renders normally. Use your cluster FQDN as the single target so metrics remain available if a node goes down. 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] > We recommend running Prometheus in Docker only for development and testing. 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 version: '3' services: prometheus-server: image: prom/prometheus ports: - 9090:9090 volumes: - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml # Persistent storage for Prometheus - prometheus-data:/prometheus grafana-ui: image: grafana/grafana ports: - 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: ```sh $ docker compose up -d ``` 1. To check that all of the containers are up, run: ```sh docker ps ``` 1. In your browser, sign in to Prometheus at `http://localhost:9090` to make sure the server is running. 1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Software cluster. ![The Redis Software target showing that Prometheus is connected to the Redis Software Cluster.](https://redis.io/docs/latest/images/rs/prometheus-target.png) If Prometheus is connected to the cluster, you can type **node_up** in the Expression field on the Prometheus home page to see the cluster metrics. To confirm you are not scraping duplicate targets, query `count(up{job="redis-enterprise"})`. A correct configuration returns `1`. To confirm the cluster can reach every node, query `node_metrics_up`, which reports `0` for any node the aggregator failed to scrape. 1. Configure the Grafana datasource: 1. Sign in to Grafana. If you installed Grafana locally, go to `http://localhost:3000` and sign in with: - Username: admin - Password: secret 1. In the Grafana configuration menu, select **Data Sources**. 1. Select **Add data source**. 1. Select **Prometheus** from the list of data source types. ![The Prometheus data source in the list of data sources on Grafana.](https://redis.io/docs/latest/images/rs/prometheus-datasource.png) 1. Enter the Prometheus configuration information: - Name: `redis-enterprise` - URL: `http://:9090` ![The Prometheus connection form in Grafana.](https://redis.io/docs/latest/images/rs/prometheus-connection.png) > [!NOTE] > - If the network port is not accessible to the Grafana server, select the **Browser** option from the Access menu. > - In a testing environment, you can select **Skip TLS verification**. 1. Add dashboards for cluster, database, node, and shard metrics. 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-software). 1. To set up alerts in Prometheus or Grafana, see the following resources: **v2 (metrics stream engine):** 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) - [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/) **v1 (deprecated):** 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) - [Example Prometheus alert rules for v1 metrics](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus/rules/alerts.yml) - [Official Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) ## Grafana dashboards for Redis Software Redis publishes preconfigured dashboards for Redis Software and Grafana. > [!NOTE] > V1 dashboards are not compatible with the v2 metrics exporter endpoint. Make sure to use the correct dashboard version for your metrics endpoint. These dashboards are open source. For additional dashboard options, or to file an issue, see the [Redis Software observability Github repository](https://github.com/redis-field-engineering/redis-enterprise-observability/). For more information about configuring Grafana dashboards, see the [Grafana documentation](https://grafana.com/docs/). **v2 (metrics stream engine):** Use the following dashboards when connecting to the v2 metrics endpoint (`https://:8070/v2`): * The [cluster status dashboard](https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/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_v2/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_v2/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_v2/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_v2/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json) displays metrics specific to [Active-Active databases](https://redis.io/docs/latest/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. **v1 (deprecated):** 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](https://redis.io/docs/latest/operate/rs/databases/active-active).