Hardware Dashboard

On this page Carat arrow pointing down
Warning:
Cockroach Labs will stop providing Assistance Support for v23.1 on November 15, 2024. Prior to that date, upgrade to a more recent version to continue receiving support. For more details, refer to the Release Support Policy.

The Hardware dashboard lets you monitor the hardware utilization of your cluster. This includes CPU usage, disk throughput, network traffic, storage capacity, and memory.

To view this dashboard, access the DB Console, click Metrics in the left-hand navigation, and select Dashboard > Hardware.

Dashboard navigation

Use the Graph menu to display metrics for your entire cluster or for a specific node.

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the SQL Activity pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, a tooltip will appear at your mouse cursor providing further insight into the data under the mouse cursor. Click anywhere within the graph to pin the tooltip in place, decoupling the tooltip from your mouse movements. Click anywhere within the graph to cause the tooltip to follow your mouse once more.

The Hardware dashboard displays the following time series graphs:

CPU Percent

DB Console CPU Percent graph

The CPU Percent graph displays the current user and system CPU percentage consumed by the CockroachDB process, normalized by number of cores, as tracked by the sys.cpu.combined.percent-normalized metric.

Note:

This graph shows the CPU consumption by the CockroachDB process, and excludes other processes on the node. Use the Host CPU Percent graph to measure the total CPU consumption across all processes.

  • In the node view, the graph shows the percentage of CPU in use by the CockroachDB process for the selected node.

  • In the cluster view, the graph shows the percentage of CPU in use by the CockroachDB process across all nodes.

Expected values for a healthy cluster: CPU utilized by CockroachDB should not persistently exceed 80%. Because this metric does not reflect system CPU usage, values above 80% suggest that actual CPU utilization is nearing 100%.

Note:

For multi-core systems, the percentage of CPU usage is calculated by normalizing the CPU usage across all cores, whereby 100% utilization indicates that all cores are fully utilized.

Host CPU Percent

DB Console CPU Percent graph

The Host CPU Percent graph displays the current user and system CPU percentage consumed by all processes on the host OS, normalized by number of cores, as tracked by the sys.cpu.host.combined.percent-normalized metric. If the CockroachDB process is run in a containerized environment, the host OS is the container since the CockroachDB process cannot inspect CPU usage beyond the container.

  • In the node view, the graph shows the percentage of CPU in use by all processes for the selected node.

  • In the cluster view, the graph shows the percentage of CPU in use by all processes across all nodes.

Note:

For multi-core systems, the percentage of CPU usage is calculated by normalizing the CPU usage across all cores, where 100% utilization indicates that all cores are fully utilized.

Memory Usage

DB Console Memory Usage graph

Note:

This graph shows the memory consumption by the CockroachDB process only and is useful as long as there are no other processes consuming significant memory on the node. In case you have other processes running on the node, use a separate monitoring tool to measure the total memory consumption across all processes.

  • In the node view, the graph shows the memory in use by CockroachDB for the selected node.

  • In the cluster view, the graph shows the memory in use by CockroachDB across all nodes in the cluster.

Disk Read Bytes

DB Console Disk Read Bytes graph

  • In the node view, the graph shows the 10-second average of the number of bytes read per second by all processes, including CockroachDB, for the selected node.

  • In the cluster view, the graph shows the 10-second average of the number of bytes read per second by all processes, including CockroachDB, across all nodes.

Disk Write Bytes

DB Console Disk Write Bytes graph

  • In the node view, the graph shows the 10-second average of the number of bytes written per second by all processes, including CockroachDB, for the node.

  • In the cluster view, the graph shows the 10-second average of the number of bytes written per second by all processes, including CockroachDB, across all nodes.

Disk Read Ops

DB Console Disk Read Ops graph

  • In the node view, the graph shows the 10-second average of the number of disk read ops per second for all processes, including CockroachDB, for the selected node.

  • In the cluster view, the graph shows the 10-second average of the number of disk read ops per second for all processes, including CockroachDB, across all nodes.

Disk Write Ops

DB Console Disk Write Ops graph

  • In the node view, the graph shows the 10-second average of the number of disk write ops per second for all processes, including CockroachDB, for the node.

  • In the cluster view, the graph shows the 10-second average of the number of disk write ops per second for all processes, including CockroachDB, across all nodes.

Disk Ops In Progress

  • In the node view, the graph shows the number of disk reads and writes in queue for all processes, including CockroachDB, for the selected node.

  • In the cluster view, the graph shows the number of disk reads and writes in queue for all processes, including CockroachDB, across all nodes in the cluster.

Note:

Expected values for a healthy cluster: This value should be 0 or single-digit values for short periods of time. If the values persist in double digits, you may have an I/O bottleneck.

Note:

On macOS, this graph is currently not populated and shows zero disk ops in progress.

Available Disk Capacity

DB Console Disk Capacity graph

Metric Description
Available Disk Capacity Free disk space available to CockroachDB data on each node.

Capacity metrics

The available disk capacity equals the amount of empty disk space, up to the value of the maximum store size. The store size is determined as follows:

  • If a store size was specified using the --store flag when starting nodes, this value is used as the limit for CockroachDB data.
  • If no store size has been explicitly set, the actual disk capacity is used as the limit for CockroachDB data.

The disk usage of the Cockroach binary, operating system, and other system files is not shown on the Available Disk Capacity graph.

Note:

If you are testing your deployment locally with multiple CockroachDB nodes running on a single machine (this is not recommended in production), you must explicitly set the store size per node in order to display the correct capacity. Otherwise, the machine's actual disk capacity will be counted as a separate store for each node, thus inflating the computed capacity.

Network Bytes Received

DB Console Network Bytes Received graph

  • In the node view, the graph shows the 10-second average of the number of network bytes received per second for all processes, including CockroachDB, for the node.

  • In the cluster view, the graph shows the 10-second average of the number of network bytes received for all processes, including CockroachDB, per second across all nodes.

Network Bytes Sent

DB Console Network Bytes Sent graph

  • In the node view, the graph shows the 10-second average of the number of network bytes sent per second by all processes, including CockroachDB, for the node.

  • In the cluster view, the graph shows the 10-second average of the number of network bytes sent per second by all processes, including CockroachDB, across all nodes.

See also


Yes No
On this page

Yes No