The Storage dashboard lets you monitor the storage utilization of your cluster.
To view this dashboard, access the DB Console, click Metrics in the left-hand navigation, and select Dashboard > Storage.
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.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the metrics used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.
In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the right of the legend. This is to limit the size of the legend so that it does not get endlessly large, particularly on clusters with many nodes.
Per store metrics
To display per store metrics, select a specific node in the Graph menu. An aggregate metric for that node as well as a metric for each store of that node will be displayed for L0 SSTable Count, L0 SSTable Size, and some other graphs.
The Storage dashboard displays the following time series graphs:
Capacity
You can monitor the Capacity graph to determine when additional storage is needed (e.g., by scaling your cluster).
| Metric | Description |
|---|---|
| Max | The maximum store size. This value may be set per node using --store. If a store size has not been set, this metric displays the actual disk capacity. See Capacity metrics. |
| Available | The free disk space available to CockroachDB data. |
| Used | The disk space in use by CockroachDB data. This excludes the Cockroach binary, operating system, and other system files. |
Expected values for a healthy cluster: Used capacity should not persistently exceed 80% of the total capacity.
For instructions on how to free up disk space as quickly as possible after deleting data, see How can I free up disk space quickly?
Capacity metrics
The Capacity graph displays disk usage by CockroachDB data in relation to the maximum store size, which is determined as follows:
- If a store size was specified using the
--storeflag 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 available capacity thus equals the amount of empty disk space, up to the value of the maximum store size. The used capacity refers only to disk space occupied by CockroachDB data, which resides in the store directory on each node.
The disk usage of the Cockroach binary, operating system, and other system files is not shown on the Capacity graph.
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.
Live Bytes
The Live Bytes graph displays the amount of data that can be read by applications and CockroachDB.
| Metric | Description |
|---|---|
| Live | Number of logical bytes stored in live key-value pairs. Live data excludes historical and deleted data. |
| System | Number of physical bytes stored in system key-value pairs. This includes historical and deleted data that has not been garbage collected. |
Logical bytes reflect the approximate number of bytes stored in the database. This value may deviate from the number of physical bytes on disk, due to factors such as compression and write amplification.
L0 SSTable Count
In the node view, the graph shows the number of L0 SSTables in use for each store of that node.
In the cluster view, the graph shows the total number of L0 SSTables in use for each node of the cluster.
L0 SSTable Size
In the node view, the graph shows the size of all L0 SSTables in use for each store of that node.
In the cluster view, the graph shows the total size of all L0 SSTables in use for each node of the cluster.
File Descriptors
In the node view, the graph shows the number of open file descriptors for that node, compared with the file descriptor limit.
In the cluster view, the graph shows the number of open file descriptors across all nodes, compared with the file descriptor limit.
If the Open count is almost equal to the Limit count, increase File Descriptors.
If you are running multiple nodes on a single machine (not recommended), the actual number of open file descriptors are considered open on each node. Thus the limit count value displayed on the DB Console is the actual value of open file descriptors multiplied by the number of nodes, compared with the file descriptor limit.
For Windows systems, you can ignore the File Descriptors graph because the concept of file descriptors is not applicable to Windows.
Disk Write Breakdown
In the node view, the graph shows the number of bytes written to disk per second categorized according to the source for that node.
In the cluster view, the graph shows the number of bytes written to disk per second categorized according to the source for each node.
Possible sources of writes with their series label are:
- WAL (
pebble-wal) - Compactions (
pebble-compaction) - SSTable ingestions (
pebble-ingestion) - Memtable flushes (
pebble-memtable-flush) - Raft snapshots (
raft-snapshot) - Encryption Registry (
encryption-registry) - Logs (
crdb-log) - SQL row spill (
sql-row-spill), refer tocockroach startcommand flag--max-disk-temp-storage - SQL columnar spill (
sql-col-spill)
To view an aggregate of all disk writes, refer to the Hardware dashboard Disk Write Bytes graph.
Other graphs
The Storage dashboard shows other time series graphs that are important for CockroachDB developers:
| Graph | Description |
|---|---|
| WAL Fsync Latency | The latency for fsyncs to the storage engine's write-ahead log. |
| Log Commit Latency: 99th Percentile | The 99th percentile latency for commits to the Raft log. This measures essentially an fdatasync to the storage engine's write-ahead log. |
| Log Commit Latency: 50th Percentile | The 50th percentile latency for commits to the Raft log. This measures essentially an fdatasync to the storage engine's write-ahead log. |
| Command Commit Latency: 99th Percentile | The 99th percentile latency for commits of Raft commands. This measures applying a batch to the storage engine (including writes to the write-ahead log), but no fsync. |
| Command Commit Latency: 50th Percentile | The 50th percentile latency for commits of Raft commands. This measures applying a batch to the storage engine (including writes to the write-ahead log), but no fsync. |
| Read Amplification | The average number of real read operations executed per logical read operation across all nodes. See Read Amplification. |
| SSTables | The number of SSTables in use across all nodes. |
| Flushes | Bytes written by memtable flushes across all nodes. |
| WAL Bytes Written | Bytes written to WAL files across all nodes. |
| Compactions | Bytes written by compactions across all nodes. |
| Ingestions | Bytes written by SSTable ingestions across all nodes. |
| Write Stalls | The number of intentional write stalls per second across all nodes, used to backpressure incoming writes during periods of heavy write traffic. |
| Time Series Writes | The number of successfully written time-series samples, and number of errors attempting to write time series samples, per second across all nodes. |
| Time Series Bytes Written | The number of bytes written by the time-series system per second across all nodes. Note that this does not reflect the rate at which disk space is consumed by time series; the data is highly compressed on disk. This rate is instead intended to indicate the amount of network traffic and disk activity generated by time-series writes. |
For monitoring CockroachDB, it is sufficient to use the Capacity and File Descriptors graphs.
Summary and events
Summary panel
A Summary panel of key metrics is displayed to the right of the timeseries graphs.
| Metric | Description |
|---|---|
| Total Nodes | The total number of nodes in the cluster. Decommissioned nodes are not included in this count. |
| Capacity Used | The storage capacity used as a percentage of usable capacity allocated across all nodes. |
| Unavailable Ranges | The number of unavailable ranges in the cluster. A non-zero number indicates an unstable cluster. |
| Queries per second | The total number of SELECT, UPDATE, INSERT, and DELETE queries executed per second across the cluster. |
| P99 Latency | The 99th percentile of service latency. |
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.
Events panel
Underneath the Summary panel, the Events panel lists the 5 most recent events logged for all nodes across the cluster. To list all events, click View all events.
The following types of events are listed:
- Database created
- Database dropped
- Table created
- Table dropped
- Table altered
- Index created
- Index dropped
- View created
- View dropped
- Schema change reversed
- Schema change finished
- Node joined
- Node decommissioned
- Node restarted
- Cluster setting changed
See also
Was this helpful?
