Network Performance Monitoring is now generally available! Network Monitoring is now available!

Redis Sentinel

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

Get metrics from Redis’s Sentinel service in real time to:

  • Visualize and monitor sentinels states
  • Be notified about failovers

Setup

The Redis’s Sentinel check is NOT included in the Datadog Agent package.

Installation

If you are using Agent v6.8+ follow the instructions below to install the Redis’s Sentinel check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior v6.8 or the Docker Agent:

  1. Install the developer toolkit.
  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the redis_sentinel package, run:

    ddev -e release build redis_sentinel
    
  5. Download and launch the Datadog Agent.

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

    datadog-agent integration install -w <PATH_OF_REDIS_SENTINEL_ARTIFACT_>/<REDIS_SENTINEL_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

Configuration

  1. Edit the redis_sentinel.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Redis Sentinel metrics. See the sample upsc.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

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

Data Collected

Metrics

redis.sentinel.known_sentinels
(gauge)
number of sentinels detected
Shown as instance
redis.sentinel.known_slaves
(gauge)
number of slaves detected
Shown as instance
redis.sentinel.last_ok_ping_latency
(gauge)
number of seconds since last OK ping
Shown as second
redis.sentinel.ok_sentinels
(gauge)
number of sentinels up and running
Shown as instance
redis.sentinel.ok_slaves
(gauge)
number of slaves up and running
Shown as instance
redis.sentinel.odown_slaves
(gauge)
number of slaves that are in the Objectively Down state
Shown as instance
redis.sentinel.sdown_slaves
(gauge)
number of slaves that are in the Subjectively Down state
Shown as instance
redis.sentinel.link_pending_commands
(gauge)
number of pending sentinel commands
Shown as command
redis.sentinel.ping_latency
(gauge)
latency of a sentinel ping
Shown as millisecond
redis.sentinel.failover
(count)
number of failovers detected
Shown as occurrence

Events

The Redis’s Sentinel check does not include any events.

Service Checks

redis.sentinel.master_is_down

The check returns:

  • OK if the master is up.
  • CRITICAL if the master is down.

redis.sentinel.master_is_disconnected

The check returns:

  • OK if the master is not disconnected.
  • CRITICAL if the master is disconnected.

redis.sentinel.slave_master_link_down

The check returns:

  • OK if the master link status is ok.
  • CRITICAL if the master link status is not ok.

redis.sentinel.slave_is_disconnected

The check returns:

  • OK if the slave is not disconnected.
  • CRITICAL if the slave is disconnected.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!