CockroachDB

Host

To configure this check for an Agent running on a host:

Metric collection

1. Edit the cockroachdb.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your CockroachDB performance data. See the sample cockroachdb.d/conf.yaml for all available configuration options.

   init_config:
   
   instances:
       ## @param openmetrics_endpoint - string - required
       ## The URL exposing metrics in the OpenMetrics format.
       #
     - openmetrics_endpoint: http://localhost:8080/_status/vars
   

2. Restart the Agent

Note: The current version of the check (1.9.0+) uses a newer implementation of OpenMetrics for metric collection, which requires Python 3. For hosts unable to use Python 3, or to use a legacy version of this check, see the following config.

Log collection

Available for Agent versions >6.0

1. Collecting logs is disabled by default in the Datadog Agent. Enable it in datadog.yaml:

   logs_enabled: true
   

2. Add this configuration block to your cockroachdb.d/conf.yaml file to start collecting your CockroachDB logs:

   logs:
    - type: file
      path: /var/lib/cockroach/logs/cockroach.log
      source: cockroachdb
      service: cockroachdb
      log_processing_rules:
      - type: multi_line
        name: new_log_start_with_status_and_date
        pattern: [A-Z]\d{6}\s\d+\:\d+\:\d+\.\d+
   

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

3. Restart the Agent.

Containerized

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

Log collection

Collecting logs is disabled by default in the Datadog Agent. To enable it, see the Docker Log Collection.

Then, set log integrations as Docker labels:

LABEL "com.datadoghq.ad.logs"='[{"source": "cockroachdb", "service": "<SERVICE_NAME>"}]'