Cockroach metrics

The OpenTelemetry Collector, when configured with a Prometheus receiver, provides an integration with Cockroach to scrape Prometheus metrics. The Collector uses the Prometheus Receiver to fetch metrics from the configured path in the Cockroach configuration file. From there, the metrics are processed and exported to Cloud Observability.

To complete the integration, you will:

• Configure the Collector to use the Cockroach endpoint as a scrape target for the Prometheus receiver.
• Enable the integration by adding it to a pipeline.

Prerequisites

• CockroachDB v21.2 or later
• You’ve configured Cockroach to send metrics to Prometheus.
• You’ve configured the Collector to export metric data to Cloud Observability.

Configure the Collector receiver

In the Collector configuration file, configure the Prometheus receiver to use the Cockroach Prometheus endpoint as a scrape target.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
receivers:
  prometheus:
    config:
      scrape_configs:
        - job_name: 'cockroachdb'
          scrape_interval: 3s
          metrics_path: '/_status/vars'
          params: 
            format: ['prometheus']
          scheme: 'http'
          tls_config:
            insecure_skip_verify: true
          static_configs:
            - targets: ['locahost:8080']

The OpenTelemetry repo’s readme provides additional details about Prometheus receiver configuration.

Enable the Collector receiver

Once the Cockroach receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.

Validate metrics are reporting to Cloud Observability

You can validate that metrics are reporting to Cloud Observability on the Metrics details page in Settings.

1. In Cloud Observability, click Settings > Metric details.

2. Search for Cockroach metric names.

   See the Cockroach’s documentation for a complete list of emitted metrics.

3. If needed, click on the metric to edit the description and how the units are displayed in Cloud Observability.

Create a dashboard for the metrics

Use the Cloud Observability Terraform Provider to create a dashboard for the metrics.

Additional resources

For a more complete example that’s ready to run, see the Cockroach integration in Cloud Observability OpenTelemetry Examples.

See also

Create and manage dashboards

Create alerts

Updated Dec 1, 2022