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

Cluster overview

Redis on Flash

Active/Active Redis

Redis Enterprise 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:

1. Download and launch the Datadog Agent.

2. 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.

3. 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

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.