RedisEnterprise (Deprecated)

Docs > Integrations > RedisEnterprise (Deprecated)

Supported OS Linux Mac OS Windows

Integration version1.2.0

Overview

This integration is will be deprecated starting on November 1, 2024. Please use the latest Redis Enterprise Datadog Integration going forward. This new integration exposes all of the latest Redis Enterprise metrics and includes updated dashboards.

This integration provides Redis Enterprise monitoring and metrics for Datadog.

What is Redis Enterprise?

Redis Enterprise is the fully supported enterprise version of Redis. In addition to the core open source Redis feature set, Redis Enterprise adds active-active geo-distribution, multi-model database features, enhanced observability, and easier multi-tenancy management for higher uptimes.

Redis Enterprise Datadog dashboard

Redis Enterprise’s Datadog integration provides a templated view across your clusters and databases allowing for operational insight unavailable in other products. Understand usage patterns and plan for growth armed with the data necessary to make informed decisions.

Database overview

overview

Cluster overview

overview

Redis on Flash

rofdash

Active/Active Redis

rofdash

Redis Enterprise events

events

Provider

This integration is provided by Redis Labs.

Setup

Installation

If you are using Agent v7.21+ / v6.21+ follow the instructions below to install the RedisEnterprise check on your host. See the dedicated Agent guide for installing community integrations to install checks with the Agent prior < v7.21 / v6.21 or the Docker Agent:

Download and launch the Datadog Agent.

Run the following command to install the integrations wheel with the Agent:

datadog-agent integration install -t datadog-redisenterprise==<INTEGRATION_VERSION>

You can find the latest version on the Datadog Integrations Release Page

Note: If necessary, prepend sudo -u dd-agent to the install command.

Configure your integration like any other packaged integration.

Configuration

Copy the sample configuration and update the required sections to collect data from your Redis Enterprise cluster

    ## @param host - string - required
    ## The RedisEnterprise host
    #
    host: myrediscluster.example.com

    ## @param port - integer - optional - default: 9443
    #
    port: 9443

    ## @param user - string - required
    ## The RedisEnterprise API user
    #
    username: redisadmin@example.com

    ## @param password - string - required
    ## The RedisEnterprise API credential
    #
    password: mySecretPassword

See the full example file for other optional settings available to match your cluster configuration.

Users can be configured according to the documentation.

Data Collected

Metrics

redisenterprise.avg_latency (gauge)	Number of seconds from when request hits proxy until results are returned Shown as microsecond
redisenterprise.avg_latency_max (gauge)	Maximum number of seconds from when request hits proxy until results are returned Shown as microsecond
redisenterprise.avg_read_latency (gauge)	Number of seconds from when a read request hits proxy until results are returned Shown as microsecond
redisenterprise.avg_other_latency (gauge)	Number of seconds from when other request hits proxy until results are returned Shown as microsecond
redisenterprise.avg_write_latency (gauge)	Number of seconds from when a write request hits proxy until results are returned Shown as microsecond
redisenterprise.cache_hit_rate (gauge)	Percentage of hits in the cache Shown as percent
redisenterprise.conns (gauge)	Number of clients currently connected to the database Shown as item
redisenterprise.egress_bytes (gauge)	Amount of network traffic sent by the database Shown as byte
redisenterprise.endpoints (gauge)	Number of proxy endpoints Shown as item
redisenterprise.evicted_objects (gauge)	Number of items evicted from the cache Shown as item
redisenterprise.expired_objects (gauge)	Number of items expired from the cache Shown as item
redisenterprise.fork_cpu_system (gauge)	% cores utilization in system mode for all redis shard fork child processes of this database Shown as percent
redisenterprise.ingress_bytes (gauge)	Amount of network traffic received by the database Shown as byte
redisenterprise.listener_acc_latency (gauge)	Accumulative latency of all types of commands on DB Shown as second
redisenterprise.main_thread_cpu_system (gauge)	% cores utilization in system mode for all redis shard main threas of this database Shown as percent
redisenterprise.main_thread_cpu_system_max (gauge)	Highest value of % cores utilization in system mode for all redis shard main threas of this database Shown as percent
redisenterprise.memory_limit (gauge)	Number of bytes allocated to this database Shown as byte
redisenterprise.no_of_keys (gauge)	Number of keys in the database Shown as item
redisenterprise.other_req (gauge)	Rate of other (non read/write) requests on DB (ops/sec) ie: PING, ECHO etc Shown as operation
redisenterprise.read_req (gauge)	Rate of read requests on DB (ops/sec) Shown as operation
redisenterprise.read_hits (gauge)	Rate of read hit requests on DB (ops/sec) Shown as operation
redisenterprise.read_misses (gauge)	Rate of read misses requests on DB (ops/sec) Shown as operation
redisenterprise.shard_cpu_system (gauge)	% cores utilization in system mode for all redis shard processes of this database Shown as percent
redisenterprise.shard_cpu_system_max (gauge)	Highest Value of % cores utilization in system mode for all redis shard processes of this database Shown as percent
redisenterprise.total_req (gauge)	Rate of all requests on DB (ops/sec) Shown as operation
redisenterprise.total_req_max (gauge)	Highest value of rate of all requests on DB (ops/sec) Shown as operation
redisenterprise.used_memory (gauge)	Amount of memory in use for the database Shown as byte
redisenterprise.used_memory_percent (gauge)	Percentage of memory used by the database Shown as percent
redisenterprise.write_req (gauge)	Rate of write requests on DB (ops/sec) Shown as operation
redisenterprise.write_hits (gauge)	Rate of write hit requests on DB (ops/sec) Shown as operation
redisenterprise.write_misses (gauge)	Rate of write misses requests on DB (ops/sec) Shown as operation
redisenterprise.bigstore_objs_ram (gauge)	Number of items stored in RAM only when Redis on Flash Enabled Shown as item
redisenterprise.bigstore_objs_flash (gauge)	Number of items stored on Flash only when Redis on Flash Enabled Shown as item
redisenterprise.bigstore_objs_percent (gauge)	Percentage items stored on Flash only when Redis on Flash Enabled Shown as percent
redisenterprise.bigstore_io_reads (gauge)	Rate of read requests on Redis on Flash Device (ops/sec) Shown as operation
redisenterprise.bigstore_io_writes (gauge)	Rate of write requests on Redis on Flash Device (ops/sec) Shown as operation
redisenterprise.bigstore_throughput (gauge)	Throughput for Redis on Flash for items stored on Flash Device Shown as byte
redisenterprise.big_write_ram (gauge)	Rate for Redis on Flash where items are written to RAM (ops/sec) Shown as operation
redisenterprise.big_write_flash (gauge)	Rate for Redis on Flash where items are written to Flash (ops/sec) Shown as operation
redisenterprise.big_del_ram (gauge)	Rate for Redis on Flash where items are deleted from RAM (ops/sec) Shown as operation
redisenterprise.big_del_flash (gauge)	Rate for Redis on Flash where items are deleted from Flash (ops/sec) Shown as operation
redisenterprise.total_shards_used (gauge)	Number of shards in use by the Redis Enterprise Cluster Shown as item
redisenterprise.license_shards (gauge)	Number of shards licensed to the Redis Enterprise Cluster Shown as item
redisenterprise.license_days (gauge)	Number of days remaining on the license of the Redis Enterprise Cluster Shown as item
redisenterprise.total_node_cores (gauge)	Number of CPU cores in the Redis Enterprise Cluster Shown as item
redisenterprise.total_node_memory (gauge)	Byte of memory in the Redis Enterprise Cluster Shown as byte
redisenterprise.total_node_count (gauge)	Number of nodes in the Redis Enterprise Cluster Shown as item
redisenterprise.total_active_nodes (gauge)	Number of active nodes in the Redis Enterprise Cluster Shown as item
redisenterprise.crdt_egress_bytes (gauge)	The bytes being sent to the CRDT peer Shown as byte
redisenterprise.crdt_egress_bytes_decompressed (gauge)	The decompressed bytes being sent to the CRDT peer Shown as byte
redisenterprise.crdt_ingress_bytes (gauge)	The bytes being received from the CRDT peer Shown as byte
redisenterprise.crdt_ingress_bytes_decompressed (gauge)	The decompressed bytes being received from the CRDT peer Shown as byte
redisenterprise.crdt_local_lag (gauge)	The local lag in the CRDT applies Shown as second
redisenterprise.crdt_pending_max (gauge)	The local pending writes in the CRDT max Shown as item
redisenterprise.crdt_pending_min (gauge)	The local pending writes in the CRDT min Shown as item

Service Checks

redisenterprise.running

The check returns:

OK if the RedisEnterprise cluster API is properly responding to commands
CRITICAL if the API is not properly responding

redisenterprise.license_check

The check returns:

OK if the cluster license is valid for longer than 1 week.
WARNING if cluster license expires in < 7 days.
CRITICAL if the cluster license has expired.

Note: The cluster continues to operate as normal with an expired license, however, no configuration changes can be made during this time. Contact your sales representative for a renewal.

Events

All Redis Enterprise events are collected.

Troubleshooting

Contact the Redis Field Engineering Team.