Prometheus and Grafana with Redis Enterprise Software

Use Prometheus and Grafana to collect and visualize Redis Enterprise Software metrics.

You can use Prometheus and Grafana to collect and visualize your Redis Enterprise Software metrics.

Metrics are exposed at the cluster, node, database, shard, and proxy levels.

• Prometheus is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources.
• Grafana 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 admin console

• Set up automatic alerts for node or cluster events

• Display Redis Enterprise Software metrics alongside data from other systems

In each cluster, the metrics_exporter process exposes Prometheus metrics on port 8070. Redis Enterprise version 7.8.2 introduces a preview of the new metrics stream engine that exposes the v2 Prometheus scraping endpoint at https://<IP>:8070/v2.

Quick start

To get started with Prometheus and Grafana:

1. Create a directory called 'prometheus' on your local machine.

2. Within that directory, create a configuration file called prometheus.yml.

3. Add the following contents to the configuration file and replace <cluster_name> with your Redis Enterprise cluster's FQDN:

   Note:

   We recommend running Prometheus in Docker only for development and testing.

   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: ["<cluster_name>:8070"] # For v2, use ["<cluster_name>:8070/v2"]
   

4. Set up your Prometheus and Grafana servers. To set up Prometheus and Grafana on Docker:

   1. Create a docker-compose.yml file:

      version: '3'
      services:
          prometheus-server:
              image: prom/prometheus
              ports:
                  - 9090:9090
              volumes:
                  - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
      
          grafana-ui:
              image: grafana/grafana
              ports:
                  - 3000:3000
              environment:
                  - GF_SECURITY_ADMIN_PASSWORD=secret
              links:
                  - prometheus-server:prometheus
      

   2. To start the containers, run:

      $ docker compose up -d
      

   3. To check that all of the containers are up, run: docker ps

   4. In your browser, sign in to Prometheus at http://localhost:9090 to make sure the server is running.

   5. Select Status and then Targets to check that Prometheus is collecting data from your Redis Enterprise cluster.

      

      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.

5. 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

   2. In the Grafana configuration menu, select Data Sources.

   3. Select Add data source.

   4. Select Prometheus from the list of data source types.

      

   5. Enter the Prometheus configuration information:

      • Name: redis-enterprise
      • URL: http://<your prometheus server name>:9090
      
   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.

6. Add dashboards for cluster, database, node, and shard metrics. To add preconfigured dashboards:

   1. In the Grafana dashboards menu, select Manage.
   2. Click Import.
   3. Upload one or more Grafana dashboards.

Grafana dashboards for Redis Enterprise

Redis publishes four preconfigured dashboards for Redis Enterprise and Grafana:

• The cluster status dashboard provides an overview of your Redis Enterprise clusters.
• The database status dashboard displays specific database metrics, including latency, memory usage, ops/second, and key count.
• The node metrics dashboard provides metrics for each of the nodes hosting your cluster.
• The shard metrics dashboard displays metrics for the individual Redis processes running on your cluster nodes
• The Active-Active dashboard displays metrics specific to Active-Active databases.

These dashboards are open source. For additional dashboard options, or to file an issue, see the Redis Enterprise observability Github repository.

For more information about configuring Grafana dashboards, see the Grafana documentation.