Redis Enterprise integration for Grafana Cloud
Redis Enterprise is an enterprise-grade deployment strategy for Redis, the popular and efficient database used for caching, message brokering, and data streaming. Redis Enterprise provides deployment solutions and tools for creating and maintaining both on-prem and cloud solutions.
This integration includes useful metrics to monitor Redis Enterprise deployments. Metrics like memory usage, CPU usage, replication lag, networking and log data can help teams discern, identify and visualize their Redis Enterprise environments, allowing you to monitor your environment down to the clusters, node and database level.
This integration supports Redis Enterprise software versions v6.X+.
This integration includes 8 useful alerts and 3 pre-built dashboards to help monitor and visualize Redis Enterprise metrics and logs.
Before you begin
You must configure your Redis Enterprise cluster to export Prometheus metrics for the integration to work properly.
You can access Prometheus metrics out-of-the-box if you use Redis Enterprise Software.
Generally metrics are exposed on port
8070 and are only accessible from within the cluster for security reasons. Therefore, ensure the Grafana agent can reach the internal endpoint of your environment.
If you deploy to Kubernetes using the Redis Enterprise operator, please ensure that the Grafana agent is installed in the same cluster or that the agent can reach the metrics endpoint.
Install Redis Enterprise integration for Grafana Cloud
- In your Grafana Cloud stack, click Connections in the left-hand menu.
- Find Redis Enterprise and click its tile to open the integration.
- Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Redis Enterprise metrics and logs to your Grafana Cloud instance.
- Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your Redis Enterprise setup.
Post-install configuration for the Redis Enterprise integration
After enabling the metrics generation, instruct the Grafana Agent to scrape your Redis Enterprise cluster.
targets in the snippet according to your environment.
You must configure a custom label for this integration:
redis_cluster, the value that identifies a Redis Enterprise cluster
You can define a
redis_cluster label by adding an extra label to the
scrape_configs of the Grafana agent metrics configuration.
If you want to show logs and metrics signals correlated in your dashboards as a single pane of glass, ensure the following:
instancelabel values must match for the Redis Enterprise integration and log scrape config in the Grafana agent configuration file.
redis_clustermust be defined that identifies the Redis Enterprise cluster the database belongs to.
- database logs are generally found at
/var/opt/redislabs/log/redis.log, adjust to match your environment.
- You will also need to add the
grafana-agentuser to the
redislabsgroup to get logs. Run the following command to configure the user as required:
sudo usermod -a -G redislabs grafana-agent
Configuration snippets for Grafana Agent
metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:
- job_name: integrations/redis-enterprise metrics_path: /metrics scheme: https # by default redis enterprise rejects insecure connections tls_config: insecure_skip_verify: true static_configs: - targets: ['<your-redis-enterprise-exporter>:8070'] relabel_configs: - replacement: '<your-cluster-name>' target_label: redis_cluster - replacement: '<your-instance-name>' target_label: instance
logs.configs.scrape_configs, insert the following lines according to your environment.
- job_name: integrations/redis-enterprise static_configs: - targets: [localhost] labels: job: integrations/redis-enterprise redis_cluster: '<your-cluster-name>' instance: '<your-instance-name>' __path__: /var/opt/redislabs/log/redis-*.log
Full example configuration for Grafana Agent
Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Redis Enterprise integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.
integrations: prometheus_remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> agent: enabled: true relabel_configs: - action: replace source_labels: - agent_hostname target_label: instance - action: replace target_label: job replacement: "integrations/agent-check" metric_relabel_configs: - action: keep regex: (prometheus_target_.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds) source_labels: - __name__ # Add here any snippet that belongs to the `integrations` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. logs: configs: - clients: - basic_auth: password: <your_loki_pass> username: <your_loki_user> url: <your_loki_url> name: integrations positions: filename: /tmp/positions.yaml scrape_configs: # Add here any snippet that belongs to the `logs.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. - job_name: integrations/redis-enterprise static_configs: - targets: [localhost] labels: job: integrations/redis-enterprise redis_cluster: '<your-cluster-name>' instance: '<your-instance-name>' __path__: /var/opt/redislabs/log/redis-*.log metrics: configs: - name: integrations remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> scrape_configs: # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. - job_name: integrations/redis-enterprise metrics_path: /metrics scheme: https # by default redis enterprise rejects insecure connections tls_config: insecure_skip_verify: true static_configs: - targets: ['<your-redis-enterprise-exporter>:8070'] relabel_configs: - replacement: '<your-cluster-name>' target_label: redis_cluster - replacement: '<your-instance-name>' target_label: instance global: scrape_interval: 60s wal_directory: /tmp/grafana-agent-wal
The Redis Enterprise integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.
- Redis Enterprise database overview
- Redis Enterprise node overview
- Redis Enterprise overview
Redis Enterprise overview (1/2)
Redis Enterprise overview (2/2)
Redis Enterprise nodes (1/2)
The Redis Enterprise integration includes the following useful alerts:
|RedisEnterpriseClusterOutOfMemory||Critical: Cluster has run out of memory.|
|RedisEnterpriseNodeNotResponding||Critical: A node in the Redis Enterprise cluster is offline or unreachable.|
|RedisEnterpriseDatabaseNotResponding||Critical: A database in the Redis Enterprise cluster is offline or unreachable.|
|RedisEnterpriseShardNotResponding||Critical: A shard in the Redis Enterprise cluster is offline or unreachable.|
|RedisEnterpriseNodeHighCPUUtilization||Warning: Node CPU usage is above the configured threshold.|
|RedisEnterpriseDatabaseHighMemoryUtilization||Warning: Node memory utilization is above the configured threshold.|
|RedisEnterpriseAverageLatencyIncreasing||Warning: Operation latency is above the configured threshold.|
|RedisEnterpriseKeyEvictionsIncreasing||Warning: The number of evicted objects is greater than or equal to the configured threshold.|
The most important metrics provided by the Redis Enterprise integration, which are used on the pre-built dashboards and Prometheus alerts, are as follows:
# 0.0.3 - September 2023 * New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working. * New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label. # 0.0.2 - August 2023 * Add regex filter for logs datasource # 0.0.1 - April 2023 * Initial release
By connecting your Redis Enterprise instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.