Authorized CockroachDB Advanced cluster users can visit the DB Console at a URL provisioned for the cluster.
Authentication
The DB Console supports username/password login and single sign-on (SSO) for Advanced and Enterprise clusters. The DB Console sign-on page can also be used to provision authentication tokens for SQL client access. Refer to:DB Console areas
Overview
The Overview page provides a cluster overview and node list and map.- has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage.
- has a list of cluster metrics at the locality and node levels.
- displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map.
Metrics
The Metrics page provides dashboards for all types of CockroachDB metrics.- has metrics about SQL performance, replication, and storage.
- has metrics about CPU usage, disk throughput, network traffic, storage capacity, and memory.
- has metrics about node count, CPU time, and memory usage.
- has metrics about SQL connections, byte traffic, queries, transactions, and service latency.
- has metrics about storage capacity and file descriptors.
- has metrics about how data is replicated across the cluster, e.g., range status, replicas per store, etc.
- has metrics about distribution tasks across the cluster, including RPCs and transactions.
- has metrics about the health and performance of various queueing systems in CockroachDB, including the garbage collection and Raft log queues.
- has metrics about important cluster tasks that take longer than expected to complete, including Raft proposals and lease acquisitions.
- has metrics about the created across your cluster.
- has metrics about the performance of the parts of your cluster relevant to the cluster’s .
- has metrics about the progress and performance of from your cluster.
- has metrics about the streams between a primary and standby cluster.
Databases
The page shows details about the system and user databases in the cluster.SQL Activity
The SQL Activity page summarizes SQL activity in your cluster.- shows frequently executed and high-latency with the option to collect statement .
- shows details about transactions running on the cluster.
- shows details about open sessions in the cluster.
Insights
The page exposes problematic health signals and enables you to quickly find optimization opportunities to maximize database efficiency. The Insights page contains workload-level and schema-level insights.Network Latency
The page shows latencies and lost connections between all nodes in your cluster.Jobs
The page shows details of jobs running in the cluster.Advanced Debug
The page provides 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. To access the Advanced Debug page, the user must be a member of theadmin role or must have the VIEWDEBUG defined.
DB Console access
You can access the DB Console from every node athttp://<host:<http-port, or http://<host:8080 by default.
- If you included the flag when starting nodes, use the IP address or hostname and port specified by that flag.
- If you didn’t include the flag when starting nodes, use the IP address or hostname specified by the flag and port
8080. - If you are running a secure cluster, use
httpsinstead ofhttp.
Accessing the DB Console for a secure cluster requires login information (i.e., username and password). This login information is stored in a system table that is replicated like other data in the cluster. If a majority of the nodes with the replicas of the system table data go down, users will be locked out of the DB Console.
Proxy DB Console
If your CockroachDB cluster is behind a load balancer, you may wish to proxy your DB Console connection to a different node in the cluster from the node you first connect to. This is useful in deployments where a third-party load balancer otherwise determines which CockroachDB node you connect to in DB Console, or where web management access is limited to a subset of CockroachDB instances in a cluster. You can accomplish this using one of these methods:- Once connected to DB Console, use the Web server dropdown menu from the page to select a different node to proxy to.
- Use the
remote_node_idparameter in your DB Console URL to proxy directly to a specific node. For example, usehttp://<host:<http-port/?remote_node_id=2to proxy directly to node2.
DB Console security considerations
Access to DB Console is a function of cluster security and the privileges of the accessing user.Cluster security
On insecure clusters, all areas of the DB Console are accessible to all users. On secure clusters, for each user who should have access to the DB Console, you must and optionally the user or membership to the .Role-based security
All users have access to data over which they have privileges (e.g., and ), and data that does not require privileges (e.g., , ). The following areas display information from privileged HTTP endpoints that require the user to have the or the specified .| DB Console area | System-level privilege | Privileged information |
|---|---|---|
| or | SQL statements | |
| or | Transactions | |
| or | Sessions | |
| or | Insights | |
| Ranges | ||
| Jobs | ||
| Debugging and profiling endpoints | ||
| Ranges | ||
| Ranges | ||
| or | Cluster Settings |
DB Console timezone configuration
To view timestamps in your preferred timezone in the DB Console, use the . This setting supports all valid timezone identifiers, such asAmerica/New_York and Asia/Tokyo.
The is now deprecated and will be removed in a future release. Avoid using
ui.display_timezone. Use ui.default_timezone instead for full support and forward compatibility.DB Console troubleshooting
The DB Console stores temporary data in a time-series database in order to generate the various metrics graphs. If your cluster is comprised of a large number of nodes where individual nodes have very limited memory available (e.g., under8 GiB), this underlying time-series database may not have enough memory available per-node to serve these requests quickly. If the DB Console experiences issues rendering these metrics graphs, consider increasing the value of the flag.
Diagnostics reporting
By default, the DB Console shares anonymous usage details with Cockroach Labs. For information about the details shared and how to opt-out of reporting, see .License expiration message
If you have , a license expiration message is displayed at the top-right of the DB Console. While the license is valid, the message will readLicense expires in X days, where X is the number of days. If the license is no longer valid, the message will read License expired X days ago. Hovering over either message displays a tooltip with the expiration date of the license.
Depending on the status of your cluster’s , the following messages may be displayed in the DB Console:
- If your cluster was throttled because a valid license key was never added, the message is: This cluster was throttled because it requires a license key. Please add a license key to continue using this cluster.
- If your cluster has an invalid license key and the cluster is still in the grace period, the message is: Your license key expired on $. The cluster will be throttled on $ unless a new license key is added.
- If your cluster was throttled due to an invalid license, the message is: Your license key expired on $ and the cluster was throttled. Please add a license key to continue using this cluster.
- If the cluster is required to send telemetry but has not been sending it, and is not yet being throttled, the message is: Telemetry has not been received from some nodes in this cluster since $. These nodes will be throttled on $ unless telemetry is received.
- If the cluster is required to send telemetry but has not been sending it, and is currently being throttled, the message is: Telemetry has not been received from some nodes in this cluster since $. These nodes were throttled on $.