The CockroachDB Admin UI provides details about your cluster and database configuration, and helps you optimize cluster performance.
Admin UI 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. |
| Changefeed Details | View metrics about the changefeeds created across your cluster. |
| 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. These include details about data distribution, the state of specific queues, and slow query metrics. These details are largely intended for use by CockroachDB developers. |
Admin UI access
On insecure clusters, all areas of the Admin UI are accessible to all users.
On secure clusters, certain areas of the Admin UI can only be accessed by admin users. These areas display information from privileged HTTP endpoints that operate with admin privilege.
For security reasons, non-admin users access only the data over which they have privileges (e.g., their tables and list of sessions), and data that does not require privileges (e.g., cluster health, node status, metrics).
The default root user is a member of the admin role, but on CockroachDB clusters prior to v20.1, the Admin UI cannot be accessed by root. To access the secure Admin UI areas, grant a user membership to the admin role:
GRANT admin TO <sql_user>;
| Secure area | Privileged information |
|---|---|
| Node Map | Database and table names |
| Database Details | Stored table data |
| Statements Details | SQL statements |
| Jobs Details | SQL statements and operational details |
| Advanced Debugging Pages (some reports) | Stored table data, operational details, internal IP addresses, names, credentials, application data (depending on report) |
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.
See also
Was this helpful?
