CockroachDB integration for Grafana Cloud
CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters.
This integration includes 8 useful alerts and 4 pre-built dashboards to help monitor and visualize CockroachDB metrics.
Before you begin
CockroachDB exposes a Prometheus metrics endpoint that is enabled by default.
Install CockroachDB integration for Grafana Cloud
- In your Grafana Cloud stack, click Connections in the left-hand menu.
- Find CockroachDB and click its tile to open the integration.
- Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send CockroachDB metrics to your Grafana Cloud instance.
- Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your CockroachDB setup.
Post-install configuration for the CockroachDB integration
Instruct Grafana Agent to scrape your CockroachDB nodes.
CockroachDB exposes a
/_status/vars endpoint. To scrape it, add the provided snippet to your agent configuration file.
cluster label must be added to each scrape, as shown in the code snippet. This is used as a filter in the dashboards, so you can monitor your nodes by cluster. Make sure to give it a value according to your environment.
Make sure to change
targets in the snippet according to your environment.
Configuration snippets for Grafana Agent
metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:
- job_name: integrations/cockroachdb metrics_path: /_status/vars relabel_configs: - replacement: '<your-instance-name>' target_label: instance static_configs: - targets: ['localhost:8080'] labels: cluster: cloud
Full example configuration for Grafana Agent
Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the CockroachDB integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.
integrations: prometheus_remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> agent: enabled: true relabel_configs: - action: replace source_labels: - agent_hostname target_label: instance - action: replace target_label: job replacement: "integrations/agent-check" metric_relabel_configs: - action: keep regex: (prometheus_target_.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds) source_labels: - __name__ # Add here any snippet that belongs to the `integrations` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. logs: configs: - clients: - basic_auth: password: <your_loki_pass> username: <your_loki_user> url: <your_loki_url> name: integrations positions: filename: /tmp/positions.yaml scrape_configs: # Add here any snippet that belongs to the `logs.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. metrics: configs: - name: integrations remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> scrape_configs: # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. - job_name: integrations/cockroachdb metrics_path: /_status/vars relabel_configs: - replacement: '<your-instance-name>' target_label: instance static_configs: - targets: ['localhost:8080'] labels: cluster: cloud global: scrape_interval: 60s wal_directory: /tmp/grafana-agent-wal
The CockroachDB integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.
- Cockroach Replicas
- Cockroach Runtime
- Cockroach SQL
- Cockroach Storage
CockroachDB Replicas - 1
CockroachDB Runtime - 1
CockroachDB Storage - 1
The CockroachDB integration includes the following useful alerts:
|CockroachInstanceFlapping||Warning: CockroachDB instances have restarted in the last 10 minutes.|
|CockroachLivenessMismatch||Warning: CockroachDB has liveness mismatches.|
|CockroachVersionMismatch||Warning: CockroachDB cluster is running different versions.|
|CockroachStoreDiskLow||Critical: CockroachDB is at low disk capacity.|
|CockroachClusterDiskLow||Critical: CockroachDB cluster is at critically low disk capacity.|
|CockroachUnavailableRanges||Critical: CockroachDB has unavailable ranges.|
|CockroachNoLeaseRanges||Warning: CockroachDB has ranges without leases.|
|CockroachHighOpenFDCount||Warning: CockroachDB has too many open file descriptors.|
The most important metrics provided by the CockroachDB integration, which are used on the pre-built dashboards and Prometheus alerts, are as follows:
# 0.0.6 - September 2023 * New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working. * New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label. # 0.0.5 - May 2023 * Add summary and description to alerts to give better visibility of alerts at a glance # 0.0.4 - February 2023 * Added Grafana Agent Operator configuration snippet to support CockroachDB in a kubernetes cluster. # 0.0.3 - June 2022 * Add cluster label to agent config * Rename `node` to `instance` to be consistent with other dashboards, and the prometheus scraping convention * Add job matcher to all queries on all dashboards, with corresponding dashboard template variable # 0.0.2 - October 2021 * Update all rate queries to use `$__rate_interval`, so they respect the default resolution # 0.0.1 - December 2020 * Initial release
By connecting your CockroachDB instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.