Most of the functionality on this page can only be accessed by an admin user. See DB Console security.
The Advanced Debug page of the DB Console provides links to advanced monitoring and troubleshooting reports and cluster configuration details. To view this page, access the DB Console and click Advanced Debug in the left-hand navigation.
These pages are experimental and undocumented. If you find an issue, let us know through these channels.
License and node information
On the right-side of the page, the following information is displayed:
- CockroachDB license type: Helps determine if you have access to Enterprise features.
- Current node ID: Helps identify the current node when viewing the DB Console through a load balancer.
Reports and Configuration
The following debug reports and configuration views are useful for monitoring and troubleshooting CockroachDB:
| Report | Description | Access level |
|---|---|---|
| Custom Time Series Chart | Create a custom chart of time series data. | All users |
| Problem Ranges | View ranges in your cluster that are unavailable, underreplicated, slow, or have other problems. | admin users only on secure clusters |
| Network Latency | Check latencies between all nodes in your cluster. | All users |
| Data Distribution and Zone Configs | View the distribution of table data across nodes and verify zone configuration. | admin users only on secure clusters |
| Cluster Settings | View cluster settings and their configured values. | All users can view data according to their privileges |
| Localities | Check node localities for your cluster. | admin users only on secure clusters |
Even More Advanced Debugging
The Even More Advanced Debugging section of the page lists additional reports that are largely internal and intended for use by CockroachDB developers. You can ignore this section while monitoring and troubleshooting CockroachDB. Alternatively, if you want to learn how to use these pages, feel free to contact us through these channels.
Raw Status Endpoints (JSON)
Depending on your access level, the endpoints listed here provide access to:
- Log files
- Secondary log files (e.g., storage engine logs, execution logs, slow query logs, authentication logs)
- Node status
- Hot ranges
- Node-specific metrics
- Session data
- Cluster-wide range data
- Allocator runs
See also
Was this helpful?
