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:
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.
Once the Cockroach receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.
You can validate that metrics are reporting to Cloud Observability on the Metrics details page in Project settings.
In Cloud Observability, click Project settings > Metric details.
Search for Cockroach metric names.
See the Cockroach’s documentation for a complete list of emitted metrics.
If needed, click on the metric to edit the description and how the units are displayed in Cloud Observability.
Use the Cloud Observability Terraform Provider to create a dashboard for the metrics.
For a more complete example that’s ready to run, see the Cockroach integration in Cloud Observability OpenTelemetry Examples.
Updated Dec 1, 2022