Warning:
As of April 30, 2020, CockroachDB v2.1 is no longer supported. For more details, refer to the Release Support Policy.
The CockroachDB Admin UI provides details about your cluster and database configuration, and helps you optimize cluster performance by monitoring the following areas:
Area | Description |
---|---|
Node Map | View and monitor the metrics and geographical configuration of your cluster. |
Cluster Health | View essential metrics about the cluster's health, such as the number of live, dead, and suspect nodes, the number of unavailable ranges, and the queries per second and service latency across the cluster. |
Overview Metrics | View important SQL performance, replication, and storage metrics. |
Hardware Metrics | View metrics about CPU usage, disk throughput, network traffic, storage capacity, and memory. |
Runtime Metrics | View metrics about node count, CPU time, and memory usage. |
SQL Performance | View metrics about SQL connections, byte traffic, queries, transactions, and service latency. |
Storage Utilization | View metrics about storage capacity and file descriptors. |
Replication Details | View metrics about how data is replicated across the cluster, such as range status, replicas per store, and replica quiescence. |
Nodes Details | View details of live, dead, and decommissioned nodes. |
Events | View a list of recent cluster events. |
Database Details | View details about the system and user databases in the cluster. |
Statements Details | Identify frequently executed or high latency SQL statements |
Jobs Details | View details of the jobs running in the cluster. |
Advanced Debugging Pages | View advanced monitoring and troubleshooting reports. |
The Admin UI also provides details about the way data is Distributed, the state of specific Queues, and metrics for Slow Queries, but these details are largely internal and intended for use by CockroachDB developers.
Note:
By default, the Admin UI shares anonymous usage details with Cockroach Labs. For information about the details shared and how to opt-out of reporting, see Diagnostics Reporting.