Redis Enterprise - Prometheus

Supported by Dynatrace

Remotely monitor your Redis Enterprise software with the official Redis Prometheus exporter.

This extensions provides the ability to remotely monitor your Redis Enterprise Clusters, Databases, Nodes, Proxies, Replicas and Shards. Every minute, this extension polls metrics through the official Redis Prometheus exporter to ingest data about how each resource is performing.

This is intended for users, who:

Would like to monitor the health state and performance of their Redis Enterprise resources.
Look for analysis support for Ops, IT and Database admins

This enables you to:

Monitor Redis with a comprehensive dashboard and Dynatrace entities
Detect anomalies and alert on them

Compatibility Requirements:

Redis Enterprise

use cases

This extension enables insights into the overall health of the Redis cluster and components.

This extension scrapes many of the metrics listed at: Redis Prometheus Metrics

Compatibility information

Redis Enterprise. Open-source Redis does not include the required metrics_exporter.

Detail

This extension uses the Redis Enterprise Prometheus Endpoint to scrape and ingest metrics.

This Redis metrics_exporter component is enabled by default and listens on Port 8070.

In Dynatrace, create a new Monitoring Configuration and select 'Monitor Remotely without OneAgent" near the bottom of the Monitoring Source Screen.

Select the Dynatrace ActiveGate group to run this extension from
Add the Redis Prometheus endpoint e.g. https://redis.cluster:8070. With auth if required.
Add a basic description and select 'Activate'

[Optional] Redis Configuration

The Database name - label "bdb_name" is not enabled by default. Without this, Dynatrace will just use the database ID in dimensions and entity definitions.

To enable it for all databases on a cluster you have to issue the following commands:

ccs-cli hset cluster_settings metrics_exporter_expose_bdb_name enabled
supervisorctl restart metrics_exporter

The new labels will then be added to the Prometheus metrics once this setting is changed and the metrics_exporter process is restarted.

Get started

Simply activate the extension in your environment using the in-product Hub, provide the necessary device configuration and you’re all set up.

Metrics

Name	Metric key	Unit	Description
DB Read Latency Max	redis.bdb_avg_read_latency_max	Second	Highest value of average latency of read operations (seconds); returned only when there is traffic
DB Write Latency Max	redis.bdb_avg_write_latency_max	Second	Highest value of average latency of write operations (seconds); returned only when there is traffic
DB Client Connections	redis.bdb_conns	Count	Number of client connections to DB
DB Outgoing Traffic	redis.bdb_egress_bytes	BytePerSecond	Rate of outgoing network traffic from the DB (bytes/sec)
DB Incoming Traffic	redis.bdb_ingress_bytes	BytePerSecond	Rate of incoming network traffic to the DB (bytes/sec)
DB Memory Limit	redis.bdb_memory_limit	Byte	Configured RAM limit for the database
DB Request Rate	redis.bdb_total_req	PerSecond	Rate of all requests on DB (ops/sec)
Database Status	redis.bdb_up	Count	Database is up and running
DB Used Memory	redis.bdb_used_memory	Byte	Memory used by db (in bigredis this includes flash) (bytes)
DB Average Latency	redis.bdb_avg_latency	Second	Average latency of operations on the DB (seconds); returned only when there is traffic
DB Number of Keys	redis.bdb_no_of_keys	Count	Number of Keys in DB

Name	Metric key	Unit	Description
Redis AOF Delayed Fsync	redis.redis_aof_delayed_fsync	Count	Number of times an AOF fsync caused delays in the redis main thread (inducing latency); This can indicate that the disk is slow or overloaded
Redis Blocked Clients	redis.redis_blocked_clients	Count	Count the clients waiting on a blocking call
Redis Connected Clients	redis.redis_connected_clients	Count	Number of client connections to the specific shard
Redis Up Status	redis.redis_up	Count	Shard is up and running
Redis Total Commands Processed	redis.redis_total_commands_processed	Count	Number of commands processed by the shard; Calculate the number of commands for a time period by comparing the value at different times
Redis Total Commands Received	redis.redis_total_connections_received	Count	Number of connections received by the shard; Calculate the number of connections for a time period by comparing the value at different times
Redis Used Memory	redis.redis_used_memory	Byte	Memory used by shard (in bigredis this includes flash) (bytes)

Name	Metric key	Unit	Description
CRDB Incoming Compressed Traffic Rate	redis.bdb_crdt_syncer_ingress_bytes	BytePerSecond	Rate of compressed incoming network traffic to CRDB (bytes/sec)
CRDB Incoming Decompressed Traffic Rate	redis.bdb_crdt_syncer_ingress_bytes_decompressed	BytePerSecond	Rate of decompressed incoming network traffic to CRDB (bytes/sec)
CRDM Traffic Lag Time	redis.bdb_crdt_syncer_local_ingress_lag_time	MilliSecond	Lag time between the source and the destination (ms) for CRDB traffic
CRDB Syncer Status	redis.bdb_crdt_syncer_status	Count	Syncer status for CRDB traffic; 0 = in-sync, 1 = syncing, 2 = out of sync

Name	Metric key	Unit	Description
Listener AUTH Commands	redis.listener_auth_cmds	Count	Number of memcached AUTH commands sent to the DB
Listener AUTH Errors	redis.listener_auth_errors	Count	Number of error responses to memcached AUTH commands
Endpoint Client Connections	redis.listener_conns	Count	Number of clients connected to the endpoint
Last Command Request Time	redis.listener_last_req_time	Count	Time of last command sent to the DB
Last Command Response Time	redis.listener_last_res_time	Count	Time of last response sent from the DB
Client Connection Rate	redis.listener_total_connections_received	PerSecond	Rate of new client connections to the endpoint (connections/sec)
Endpoint Request Rate	redis.listener_total_req	PerSecond	Request rate handled by the endpoint (ops/sec)
Endpoint Response Rate	redis.listener_total_res	PerSecond	Rate of all responses on the endpoint (ops/sec)
Number of Database Responses	redis.listener_total_started_res	Count	Number of responses sent from the DB of all types
Endpoint Write Response Rate	redis.listener_write_res	PerSecond	Rate of write responses on the endpoint (ops/sec)
Endpoint Write Response Count	redis.listener_write_started_res	Count	Number of responses sent from the DB of type “write”

Name	Metric key	Unit	Description
Node Available Memory	redis.node_available_memory	Byte	Amount of free memory in node (bytes) that is available for database provisioning
Node Average Latency	redis.node_avg_latency	Second	Average latency of requests handled by endpoints on node (seconds); returned only when there is traffic
Node Client Connections	redis.node_conns	Count	Number of clients connected to endpoints on node
Node Outgoing Traffic	redis.node_egress_bytes	BytePerSecond	Rate of outgoing network traffic to node (bytes/sec)
Node Incoming Traffic	redis.node_ingress_bytes	BytePerSecond	Rate of incoming network traffic to node (bytes/sec)
Node Persistent Storage Available	redis.node_persistent_storage_avail	Byte	Disk space available to RLEC processes on configured persistent disk (bytes)
-	redis.node_persistent_storage_free	-	-
Node Provisional Memory	redis.node_provisional_memory	Byte	Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases
Node Request Rate	redis.node_total_req	PerSecond	Request rate handled by endpoints on node (ops/sec)
Node Up Status	redis.node_up	Count	Node is part of the cluster and is connected