Skip to main content

CockroachDB monitoring with Netdata

CockroachDB is the SQL database for building global, scalable cloud services that survive disasters.

This module will monitor one or more CockroachDB databases, depending on your configuration.


It produces the following charts:

Process Statistics

  • Combined CPU Time Percentage, Normalized 0-1 by Number of Cores in percantage
  • CPU Time Percentage in percentage
  • CPU Time in ms
  • Memory Usage in KiB
  • File Descriptors in fd
  • Uptime in seconds

Host Statistics

  • Host Disk Cumulative Bandwidth in KiB
  • Host Disk Cumulative Operations in operations
  • Host Disk Cumulative IOPS In Progress in iops
  • Host Network Cumulative Bandwidth in kilobits
  • Host Network Cumulative Packets in packets
  • Uptime in seconds


  • Live Nodes in the Cluster in num
  • Node Liveness Heartbeats in heartbeats


  • Total Storage Capacity in KiB
  • Storage Capacity Usability in KiB
  • Storage Usable Capacity in KiB
  • Storage Used Capacity Utilization in percentage


  • Active SQL Connections in connections
  • SQL Bandwidth in KiB
  • SQL Statements Total in statements
  • SQL Statements and Transaction Errors in errors
  • SQL Started DDL Statements in statements
  • SQL Executed DDL Statements in statements
  • SQL Started DML Statements in statements
  • SQL Executed DML Statements in statements
  • SQL Started TCL Statements in statements
  • SQL Executed TCL Statements in statements
  • Active Distributed SQL Queries in queries
  • Distributed SQL Flows in flows


  • Used Live Data in KiB
  • Logical Data in KiB
  • Logical Data Count in num

KV Transactions

  • KV Transactions in transactions
  • KV Transaction Restarts in restarts


  • Ranges in num
  • Problem Ranges in ranges
  • Range Events in events
  • Range Snapshot Events in events


  • RocksDB Read Amplification in reads/query
  • RocksDB Table Operations in operations
  • RocksDB Block Cache Operations in operations
  • RocksDB Block Cache Hit Rate in percentage
  • RocksDB SSTables in num


  • Number of Replicas in num
  • Replicas Quiescence in replicas
  • Number of Raft Leaders in num
  • Number of Leaseholders in num
  • RocksDB SSTables in num


  • Queues Processing Failures in failures


  • Rebalancing Average Queries in queries/s
  • Rebalancing Average Writes in writes/s

Time Series

  • Time Series Written Samples in samples
  • Time Series Write Errors in errors
  • Time Series Bytes Written in KiB

Slow Requests

  • Slow Requests in requests


  • Heap Memory Usage in KiB
  • Number of Goroutines in num
  • GC Runs in invokes
  • GC Pause Time in us
  • Cgo Calls in calls


Edit the go.d/cockroachdb.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/cockroachdb.conf

Needs only url to server's _status/vars. Here is an example for 2 servers:

- name: local

- name: remote

For all available options please see module configuration file.

Update every

Default update_every is 10 seconds because CockroachDB default sampling interval is 10 seconds, and it is not user configurable. It doesn't make sense to decrease the value.


To troubleshoot issues with the cockroachdb collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

./go.d.plugin -d -m cockroachdb

Was this page helpful?

Need further help?

Search for an answer in our community forum.