Prometheus integration with Redis Enterprise Software
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.
To get started with Prometheus and Grafana:
Create a directory called ‘prometheus’ on your local machine.
Within that directory, create a configuration file called
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"]
Set up your Prometheus and Grafana servers. To set up Prometheus and Grafana on Docker:
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
To start the containers, run:
$ docker compose up -d
To check that all of the containers are up, run:
In your browser, sign in to Prometheus at http://localhost:9090 to make sure the server is running.
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.
Configure the Grafana datasource:
Sign in to Grafana. If you installed Grafana locally, go to http://localhost:3000 and sign in with:
- Username: admin
- Password: secret
In the Grafana configuration menu, select Data Sources.
Select Add data source.
Select Prometheus from the list of data source types.
Enter the Prometheus configuration information:
http://<your prometheus address>:9090
- 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.
Add dashboards for cluster, database, node, and shard metrics. To add preconfigured dashboards:
- In the Grafana dashboards menu, select Manage.
- Click Import.
- 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.
These dashboards are open source. For additional dashboard options, or to file an issue, see the Redis Enterprise Grafana Dashboards Github repository.
For more information about configuring Grafana dashboards, see the Grafana documentation.