Overview

RethinkDB is a distributed documented-oriented NoSQL database, with first class support for realtime change feeds.

This check monitors a RethinkDB cluster through the Datadog Agent and collects metrics about performance, data availability, cluster configuration, and more.

Note: this integration is compatible with RethinkDB version 2.3.6 and above.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The RethinkDB check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

1. If using RethinkDB 2.4+, add a datadog-agent user with read-only permissions on the rethinkdb database. You can use the following ReQL commands, and see Permissions and user accounts for details:

   r.db('rethinkdb').table('users').insert({'id': 'datadog-agent', 'password': '<PASSWORD>'})
   r.db('rethinkdb').grant('datadog-agent', {'read': True})
   

   Note: on RethinkDB 2.3.x, granting permissions on the rethinkdb database is not supported. Skip this step and use your admin account below instead.

2. Edit the rethinkdb.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample rethinkdb.d/conf.yaml for all available configuration options.

   init_config:
   
   instances:
     - host: localhost
       port: 28015
       user: "<USER>"
       password: "<PASSWORD>"
   

3. Restart the Agent.

Note: this integration collects metrics from all servers in the cluster, so you only need a single Agent.

Log collection

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

   logs_enabled: true
   

2. Edit this configuration block in your rethinkdb.d/conf.yaml file to start collecting your RethinkDB logs:

   logs:
     - type: file
       path: "<LOG_FILE_PATH>"
       source: rethinkdb
       service: "<SERVICE_NAME>"
   

   Change the path parameter value based on your environment. See the sample conf.yaml for all available configuration options.

3. Restart the Agent.

To enable logs for Kubernetes environments, see Kubernetes Log Collection.

Validation

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

Data Collected

Metrics

Events

RethinkDB does not include any events.

Service Checks

rethinkdb.can_connect
Returns CRITICAL if the Agent is unable to reach the configured RethinkDB server, OK otherwise.
Statuses: ok, critical

rethinkdb.table_status.status.ready_for_outdated_reads
Returns OK if all shards of a table are ready to accept outdated read queries, WARNING otherwise.
Statuses: ok, warning

rethinkdb.table_status.status.ready_for_reads
Returns OK if all shards of a table are ready to accept read queries, WARNING otherwise.
Statuses: ok, warning

rethinkdb.table_status.status.ready_for_writes
Returns OK if all shards of a table are ready to accept write queries, WARNING otherwise.
Statuses: ok, warning

rethinkdb.table_status.status.all_replicas_ready
Returns OK if all replicas are ready for reads and writes, WARNING otherwise (e.g. if backfills are in progress).
Statuses: ok, warning

Troubleshooting

Need help? Contact Datadog support.