--- title: RedisEnterprise (Deprecated) description: Redis Enterprise Observability breadcrumbs: Docs > Integrations > RedisEnterprise (Deprecated) --- # RedisEnterprise (Deprecated) Supported OS Integration version1.2.0 ## Overview{% #overview %} **This integration is deprecated as of November 1, 2024. Please use the latest [Redis Enterprise Datadog Integration](https://docs.datadoghq.com/integrations/redis_enterprise/) going forward. This new integration exposes all of the latest Redis Enterprise metrics and includes updated dashboards.** This integration provides [Redis Enterprise](http://www.redislabs.com) monitoring and metrics for Datadog. ### What is Redis Enterprise?{% #what-is-redis-enterprise %} [Redis Enterprise](http://www.redislabs.com) 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-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{% #database-overview %} #### Cluster overview{% #cluster-overview %} #### Redis on Flash{% #redis-on-flash %} #### Active/Active Redis{% #activeactive-redis %} #### Redis Enterprise events{% #redis-enterprise-events %} ### Provider{% #provider %} This integration is provided by Redis Labs. ## Setup{% #setup %} ### Installation{% #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](https://docs.datadoghq.com/agent/guide/use-community-integrations/?tab=agentv721v621) to install checks with the [Agent prior < v7.21 / v6.21](https://docs.datadoghq.com/agent/guide/use-community-integrations/?tab=agentearlierversions) or the [Docker Agent](https://docs.datadoghq.com/agent/guide/use-community-integrations/?tab=docker): 1. [Download and launch the Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest). 1. Run the following command to install the integrations wheel with the Agent: ```shell datadog-agent integration install -t datadog-redisenterprise== ``` You can find the latest version on the [Datadog Integrations Release Page](https://github.com/DataDog/integrations-extras/tags) **Note**: If necessary, prepend `sudo -u dd-agent` to the install command. Configure your integration like [any other packaged integration](https://docs.datadoghq.com/getting_started/integrations/). ### Configuration{% #configuration %} Copy the [sample configuration](https://github.com/DataDog/integrations-extras/blob/master/redisenterprise/datadog_checks/redisenterprise/data/conf.yaml.example) and update the required sections to collect data from your Redis Enterprise cluster ```yml ## @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](https://docs.redislabs.com/latest/rc/security/database-security/passwords-users-roles/). ## Data Collected{% #data-collected %} ### Metrics{% #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{% #service-checks %} **redisenterprise.license\_check** Returns `CRITICAL` if the license has expired `WARNING` if expires in 7 days or less and OK otherwise *Statuses: ok, warning, critical* **redisenterprise.running** Returns `CRITICAL` if the cluster is not responding properly and OK otherwise *Statuses: ok, critical* ### Events{% #events %} All [Redis Enterprise events](https://docs.redislabs.com/latest/rs/administering/monitoring-metrics/#cluster-alerts) are collected. ## Troubleshooting{% #troubleshooting %} Contact the [Redis Field Engineering Team](mailto:redis.observability@redis.com?subject=Datadog%20Integration%20Support).