Redis

Agent Check

Overview

Whether you use Redis as a database, cache, or message queue, this integration helps you track problems with your Redis servers and the parts of your infrastructure that they serve. The Datadog Agent’s Redis check collects metrics related to performance, memory usage, blocked clients, slave connections, disk persistence, expired and evicted keys, and many more.

Setup

Installation

The Redis check is included in the Datadog Agent package, so you don’t need to install anything else on your Redis servers.

Configuration

Host

Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the Containerized section.

Metric collection

1. Edit the redisdb.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. The following parameters may require updating. See the sample redisdb.d/conf.yaml for all available configuration options.

   init_config:
   instances:
    ## @param host - string - required
    ## Enter the host to connect to.
    - host: localhost
      ## @param port - integer - required
      ## Enter the port of the host to connect to.
      port: 6379
   
      ## @param username - string - optional
      ## The username to use for the connection. Redis 6+ only.
      #
      # username: <USERNAME>
   
      ## @param password - string - optional
      ## The password to use for the connection.
      #
      # password: <PASSWORD>

2. If using Redis 6+ and ACLs, ensure that the user has at least DB Viewer permissions at the Database level, and Cluster Viewer permissions if operating in a cluster environment. For more details, see the documentation.

3. Restart the Agent.

Log collection

Available for Agent versions >6.0

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

   logs_enabled: true

2. Uncomment and edit this configuration block at the bottom of your redisdb.d/conf.yaml:

   logs:
    - type: file
      path: /var/log/redis_6379.log
      source: redis
      service: myapplication

   Change the path and service parameter values and configure them for your environment. See the sample redisdb.yaml for all available configuration options.

3. Restart the Agent.

Trace collection

Datadog APM integrates with Redis to see the traces across your distributed system. Trace collection is enabled by default in the Datadog Agent v6+. To start collecting traces:

1. Enable trace collection in Datadog.
2. Instrument your application that makes requests to Redis.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection

Log collection

Available for Agent versions >6.0

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection documentation.

Trace collection

APM for containerized apps is supported on hosts running Agent v6+ but requires extra configuration to begin collecting traces.

Required environment variables on the Agent container:

See Tracing Kubernetes Applications and the Kubernetes Daemon Setup for a complete list of available environment variables and configuration.

Then, instrument your application container and set DD_AGENT_HOST to the name of your Agent container.

Validation

Run the Agent’s status subcommand and look for redisdb under the Checks section.

Data Collected

Metrics

Events

The Redis check does not include any events.

Service Checks

redis.can_connect:
Returns CRITICAL if the Agent cannot connect to Redis to collect metrics, otherwise returns OK.

redis.replication.master_link_status:
Returns CRITICAL if this Redis instance is unable to connect to its master instance, otherwise returns OK.

Troubleshooting

• Redis Integration Error: “unknown command ‘CONFIG’”

Agent cannot connect

    redisdb
    -------
      - instance #0 [ERROR]: 'Error 111 connecting to localhost:6379. Connection refused.'
      - Collected 0 metrics, 0 events & 1 service chec

Check that the connection info in redisdb.yaml is correct.

Agent cannot authenticate

    redisdb
    -------
      - instance #0 [ERROR]: 'NOAUTH Authentication required.'
      - Collected 0 metrics, 0 events & 1 service check

Configure a password in redisdb.yaml.

Further Reading

Additional helpful documentation, links, and articles:

• How to monitor Redis performance metrics