Redis Enterprise - PrometheusRedis Enterprise - Prometheus
Monitor Redis Enterprise with the official Redis Prometheus exporter.
Extension
- Product information
- Release notes
Overview
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
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.
Read more in the Dynatrace Prometheus Extension Documentation
Details
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 enabledsupervisorctl 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.
Compatibility information
Redis Enterprise. Open-source Redis does not include the required metrics_exporter.
Extension content
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Listener AUTH Commands | listener_auth_cmds | Number of memcached AUTH commands sent to the DB | Count |
| Listener AUTH Errors | listener_auth_errors | Number of error responses to memcached AUTH commands | Count |
| Endpoint Client Connections | listener_conns | Number of clients connected to the endpoint | Count |
| Last Command Request Time | listener_last_req_time | Time of last command sent to the DB | Count |
| Last Command Response Time | listener_last_res_time | Time of last response sent from the DB | Count |
| Client Connection Rate | listener_total_connections_received | Rate of new client connections to the endpoint (connections/sec) | PerSecond |
| Endpoint Request Rate | listener_total_req | Request rate handled by the endpoint (ops/sec) | PerSecond |
| Endpoint Response Rate | listener_total_res | Rate of all responses on the endpoint (ops/sec) | PerSecond |
| Number of Database Responses | listener_total_started_res | Number of responses sent from the DB of all types | Count |
| Endpoint Write Response Rate | listener_write_res | Rate of write responses on the endpoint (ops/sec) | PerSecond |
| Endpoint Write Response Count | listener_write_started_res | Number of responses sent from the DB of type “write” | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| CRDB Incoming Compressed Traffic Rate | bdb_crdt_syncer_ingress_bytes | Rate of compressed incoming network traffic to CRDB (bytes/sec) | BytePerSecond |
| CRDB Incoming Decompressed Traffic Rate | bdb_crdt_syncer_ingress_bytes_decompressed | Rate of decompressed incoming network traffic to CRDB (bytes/sec) | BytePerSecond |
| CRDM Traffic Lag Time | bdb_crdt_syncer_local_ingress_lag_time | Lag time between the source and the destination (ms) for CRDB traffic | MilliSecond |
| CRDB Syncer Status | bdb_crdt_syncer_status | Syncer status for CRDB traffic; 0 = in-sync, 1 = syncing, 2 = out of sync | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| DB Read Latency Max | bdb_avg_read_latency_max | Highest value of average latency of read operations (seconds); returned only when there is traffic | Second |
| DB Write Latency Max | bdb_avg_write_latency_max | Highest value of average latency of write operations (seconds); returned only when there is traffic | Second |
| DB Client Connections | bdb_conns | Number of client connections to DB | Count |
| DB Outgoing Traffic | bdb_egress_bytes | Rate of outgoing network traffic from the DB (bytes/sec) | BytePerSecond |
| DB Incoming Traffic | bdb_ingress_bytes | Rate of incoming network traffic to the DB (bytes/sec) | BytePerSecond |
| DB Memory Limit | bdb_memory_limit | Configured RAM limit for the database | Byte |
| DB Request Rate | bdb_total_req | Rate of all requests on DB (ops/sec) | PerSecond |
| Database Status | bdb_up | Database is up and running | Count |
| DB Used Memory | bdb_used_memory | Memory used by db (in bigredis this includes flash) (bytes) | Byte |
| DB Average Latency | bdb_avg_latency | Average latency of operations on the DB (seconds); returned only when there is traffic | Second |
| DB Number of Keys | bdb_no_of_keys | Number of Keys in DB | Count |
| DB Read Hits | bdb_read_hits | Rate of read operations accessing an existing key (ops/sec) | PerSecond |
| DB Read Hits Max | bdb_read_hits_max | Highest value of rate of read operations accessing an existing key (ops/sec) | PerSecond |
| DB Read Misses | bdb_read_misses | Rate of read operations accessing a non-existing key (ops/sec) | PerSecond |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Node Available Memory | node_available_memory | Amount of free memory in node (bytes) that is available for database provisioning | Byte |
| Node Average Latency | node_avg_latency | Average latency of requests handled by endpoints on node (seconds); returned only when there is traffic | Second |
| Node Client Connections | node_conns | Number of clients connected to endpoints on node | Count |
| Node Outgoing Traffic | node_egress_bytes | Rate of outgoing network traffic to node (bytes/sec) | BytePerSecond |
| Node Incoming Traffic | node_ingress_bytes | Rate of incoming network traffic to node (bytes/sec) | BytePerSecond |
| Node Persistent Storage Available | node_persistent_storage_avail | Disk space available to RLEC processes on configured persistent disk (bytes) | Byte |
| Node Persistent Storage Free | node_persistent_storage_free | Free disk space on configured persistent disk (bytes) | Byte |
| Node Provisional Memory | node_provisional_memory | Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases | Byte |
| Node Request Rate | node_total_req | Request rate handled by endpoints on node (ops/sec) | PerSecond |
| Node Up Status | node_up | Node is part of the cluster and is connected | Count |
Full version history
Full version history
- Do not define the Redis Database topology type when
bdb_nameis not set in the prometheus export
Full version history
- Add sourceEntityType to metrics for tags and management zone support
- Add additional metric metadata
Full version history
- Collect metric: redis_db0_avg_ttl - Average TTL of all volatile keys
Full version history
- Remove redis metric prefix to match Prometheus metric names
- Update Cluster -> Node topology relationship to correctly display the full list
- Consistent database names with and without bdb_name set
Full version history
Initial published extension.
Redis Enterprise metrics for:
- Clusters
- Nodes
- Databases
- Replicas
- Proxies
- Shards
