Documentation Grafana Cloud Monitor infrastructure Grafana integrations Integrations reference Redis Enterprise

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.

If you are using Redis Enterprise Cloud to manage installs/deployments, the lowest possible tier that provisions advanced monitoring is the Fixed plan.

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 Grafana Alloy can reach the internal endpoint of your environment.

If you deploy to Kubernetes using the Redis Enterprise operator, please ensure that Grafana Alloy is installed in the same cluster or that the agent can reach the metrics endpoint.

Install Redis Enterprise integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Redis Enterprise and click its tile to open the integration.
3. 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.
4. 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.

Configuration snippets for Grafana Alloy

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Redis Enterprise instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

alloy Copy

discovery.relabel "metrics_integrations_integrations_redis_enterprise" {
	targets = [{
		__address__ = "<your-redis-enterprise-exporter>:8070",
	}]

	rule {
		target_label = "redis_cluster"
		replacement  = "<your-cluster-name>"
	}

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_redis_enterprise" {
	targets    = discovery.relabel.metrics_integrations_integrations_redis_enterprise.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/redis-enterprise"
	scheme     = "https"

	tls_config {
		insecure_skip_verify = true
	}
}

To monitor your Redis Enterprise instance, you must use a discovery.relabel component to discover your Redis Enterprise Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

• __address__: The address to your Redis Enterprise Prometheus metrics endpoint.
• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Redis Enterprise instance. Make sure this label value is the same for all telemetry data collected for this instance.
• redis_cluster: The redis_cluster label to group your Redis Enterprise instances within a cluster. Set the same value for all nodes within your cluster.

If you have multiple Redis Enterprise servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Advanced logs snippets

linux

alloy Copy

local.file_match "logs_integrations_integrations_redis_enterprise" {
	path_targets = [{
		__address__   = "localhost",
		__path__      = "/var/opt/redislabs/log/redis-*.log",
		instance      = constants.hostname,
		job           = "integrations/redis-enterprise",
		redis_cluster = "<your-cluster-name>",
	}]
}

loki.source.file "logs_integrations_integrations_redis_enterprise" {
	targets    = local.file_match.logs_integrations_integrations_redis_enterprise.targets
	forward_to = [loki.write.grafana_cloud_loki.receiver]
}

To monitor your Redis Enterprise instance logs, you will use a combination of the following components:

• local.file_match defines where to find the log file to be scraped. Change the following properties according to your environment:

  • __address__: The Redis Enterprise instance address
  • __path__: database logs are generally found at /var/opt/redislabs/log/redis.log, adjust to match your environment.
  • instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Redis Enterprise instance. Make sure this label value is the same for all telemetry data collected for this instance.
  • redis_cluster: The redis_cluster label to group your Redis Enterprise instances within a cluster. Set the same value for all nodes within your cluster.

• loki.source.file sends logs to Loki.

You will also need to add the alloy user to the redislabs group to get logs. Run the following command to configure the user as required:

sh Copy

sudo usermod -a -G redislabs alloy

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Instructions for Grafana Agent static

Dashboards

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)

Alerts

The Redis Enterprise integration includes the following useful alerts:

Metrics

The most important metrics provided by the Redis Enterprise integration, which are used on the pre-built dashboards and Prometheus alerts, are as follows:

• bdb_avg_latency
• bdb_avg_read_latency
• bdb_avg_write_latency
• bdb_conns
• bdb_crdt_ingress_bytes_decompressed
• bdb_crdt_syncer_ingress_bytes
• bdb_crdt_syncer_local_ingress_lag_time
• bdb_crdt_syncer_status
• bdb_egress_bytes
• bdb_evicted_objects
• bdb_expired_objects
• bdb_ingress_bytes
• bdb_instantaneous_ops_per_sec
• bdb_mem_frag_ratio
• bdb_mem_size_lua
• bdb_memory_limit
• bdb_no_of_keys
• bdb_read_hits
• bdb_read_misses
• bdb_read_req
• bdb_up
• bdb_used_memory
• bdb_write_req
• node_available_memory
• node_avg_latency
• node_conns
• node_cpu_system
• node_cpu_user
• node_egress_bytes
• node_ephemeral_storage_free
• node_ingress_bytes
• node_persistent_storage_free
• node_total_req
• node_up
• redis_up
• redis_used_memory
• up

Changelog

md Copy

# 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

Cost

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.