> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cockroachlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DB Console Overview

The DB Console provides details about your cluster and database configuration, and helps you optimize cluster performance.

Authorized CockroachDB Dedicated cluster users can visit the DB Console at a URL provisioned for the cluster.

Refer to: [Network Authorization for CockroachDB Cloud Clusters — DB Console](https://docs.cockroachlabs.com/docs/cockroachcloud/network-authorization.md#db-console)

## Authentication

The DB Console supports username/password login and single sign-on (SSO) for Advanced and  clusters.

The DB Console sign-on page can also be used to provision authentication tokens for SQL client access.

Refer to:

* [Single Sign-on (SSO) for DB Console](https://docs.cockroachlabs.com/docs/stable/sso-db-console.md)
* [Cluster Single Sign-on (SSO) using JSON web tokens (JWTs)](https://docs.cockroachlabs.com/docs/stable/sso-sql.md)

## DB Console areas

### Overview

The Overview page provides a cluster overview and node list and map.

* [Cluster Overview](https://docs.cockroachlabs.com/docs/stable/ui-cluster-overview-page.md) has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage.
* [Node List](https://docs.cockroachlabs.com/docs/stable/ui-cluster-overview-page.md#node-map) has a list of cluster metrics at the locality and node levels.
* [Node Map](https://docs.cockroachlabs.com/docs/stable/ui-cluster-overview-page.md#node-map) 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.

* [Overview dashboard](https://docs.cockroachlabs.com/docs/stable/ui-overview-dashboard.md) has metrics about SQL performance, replication, and storage.
* [Hardware dashboard](https://docs.cockroachlabs.com/docs/stable/ui-hardware-dashboard.md) has metrics about CPU usage, disk throughput, network traffic, storage capacity, and memory.
* [Runtime dashboard](https://docs.cockroachlabs.com/docs/stable/ui-runtime-dashboard.md) has metrics about node count, CPU time, and memory usage.
* [SQL dashboard](https://docs.cockroachlabs.com/docs/stable/ui-sql-dashboard.md) has metrics about SQL connections, byte traffic, queries, transactions, and service latency.
* [Storage dashboard](https://docs.cockroachlabs.com/docs/stable/ui-storage-dashboard.md) has metrics about storage capacity and file descriptors.
* [Replication dashboard](https://docs.cockroachlabs.com/docs/stable/ui-replication-dashboard.md) has metrics about how data is replicated across the cluster, e.g., range status, replicas per store, and replica quiescence.
* [Distributed dashboard](https://docs.cockroachlabs.com/docs/stable/ui-distributed-dashboard.md) has metrics about distribution tasks across the cluster, including RPCs, transactions, and node heartbeats.
* [Queues dashboard](https://docs.cockroachlabs.com/docs/stable/ui-queues-dashboard.md) has metrics about the health and performance of various queueing systems in CockroachDB, including the garbage collection and Raft log queues.
* [Slow requests dashboard](https://docs.cockroachlabs.com/docs/stable/ui-slow-requests-dashboard.md) has metrics about important cluster tasks that take longer than expected to complete, including Raft proposals and lease acquisitions.
* [Changefeeds dashboard](https://docs.cockroachlabs.com/docs/stable/ui-cdc-dashboard.md) has metrics about the [changefeeds](https://docs.cockroachlabs.com/docs/stable/change-data-capture-overview.md) created across your cluster.
* [Overload dashboard](https://docs.cockroachlabs.com/docs/stable/ui-overload-dashboard.md) has metrics about the performance of the parts of your cluster relevant to the cluster's [admission control system](https://docs.cockroachlabs.com/docs/stable/admission-control.md).
* [TTL dashboard](https://docs.cockroachlabs.com/docs/stable/ui-ttl-dashboard.md) has metrics about the progress and performance of [batch deleting expired data using Row-Level TTL](https://docs.cockroachlabs.com/docs/stable/row-level-ttl.md) from your cluster.
* [Physical Cluster Replication dashboard](https://docs.cockroachlabs.com/docs/stable/ui-physical-cluster-replication-dashboard.md) has metrics about the [physical cluster replication](https://docs.cockroachlabs.com/docs/stable/physical-cluster-replication-overview.md) streams between a primary and standby cluster.

### Databases

The [Databases](https://docs.cockroachlabs.com/docs/stable/ui-databases-page.md) page shows details about the system and user databases in the cluster.

### SQL Activity

The **SQL Activity** page summarizes SQL activity in your cluster.

* [**Statements**](https://docs.cockroachlabs.com/docs/stable/ui-statements-page.md) shows frequently executed and high-latency [SQL statements](https://docs.cockroachlabs.com/docs/stable/sql-statements.md) with the option to collect statement [diagnostics](https://docs.cockroachlabs.com/docs/stable/ui-statements-page.md#diagnostics).
* [**Transactions**](https://docs.cockroachlabs.com/docs/stable/ui-transactions-page.md) shows details about transactions running on the cluster.
* [**Sessions**](https://docs.cockroachlabs.com/docs/stable/ui-sessions-page.md) shows details about open sessions in the cluster.

### Insights

The [**Insights**](https://docs.cockroachlabs.com/docs/stable/ui-insights-page.md) 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 [Network Latency](https://docs.cockroachlabs.com/docs/stable/ui-network-latency-page.md) page shows latencies and lost connections between all nodes in your cluster.

### Jobs

The [Jobs](https://docs.cockroachlabs.com/docs/stable/ui-jobs-page.md) page shows details of jobs running in the cluster.

### Advanced Debug

The [Advanced Debug](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md) 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 the `admin` role or must have the `VIEWDEBUG` [system privilege](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization.md#supported-privileges) defined.

## DB Console access

You can access the DB Console from every node at `http://<host:<http-port`, or `http://<host:8080` by default.

* If you included the [`--http-addr`](https://docs.cockroachlabs.com/docs/stable/cockroach-start#networking) flag when starting nodes, use the IP address or hostname and port specified by that flag.
* If you didn't include the [`--http-addr`](https://docs.cockroachlabs.com/docs/stable/cockroach-start#networking) flag when starting nodes, use the IP address or hostname specified by the [`--listen-addr`](https://docs.cockroachlabs.com/docs/stable/cockroach-start#networking) flag and port `8080`.
* If you are running a [secure cluster](#cluster-security), use `https` instead of `http`.

For guidance on accessing the DB Console in the context of cluster deployment, see [Start a Local Cluster](https://docs.cockroachlabs.com/docs/stable/start-a-local-cluster.md) and [Manual Deployment](https://docs.cockroachlabs.com/docs/stable/manual-deployment.md).

### 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 [**Advanced Debug**](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md#license-and-node-information) page to select a different node to proxy to.
* Use the `remote_node_id` parameter in your DB Console URL to proxy directly to a specific node. For example, use `http://<host:<http-port/?remote_node_id=2` to proxy directly to node `2`.

## 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 [create a user with a password](https://docs.cockroachlabs.com/docs/stable/create-user.md#create-a-user-with-a-password) and optionally [`GRANT`](https://docs.cockroachlabs.com/docs/stable/grant#grant-system-level-privileges-on-the-entire-cluster) the user [system-level privileges](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization.md#supported-privileges) or membership to the [`admin` role](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization#admin-role).

### Role-based security

All users have access to data over which they have privileges (e.g., [jobs](https://docs.cockroachlabs.com/docs/stable/ui-jobs-page.md) and [list of sessions](https://docs.cockroachlabs.com/docs/stable/ui-sessions-page.md)), and data that does not require privileges (e.g., [cluster health, node status](https://docs.cockroachlabs.com/docs/stable/ui-cluster-overview-page.md), [metrics](https://docs.cockroachlabs.com/docs/stable/ui-overview-dashboard.md)).

The following areas display information from privileged HTTP endpoints that require the user to have the [`admin` role](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization#admin-role) or the specified [system-level privileges](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization.md#supported-privileges).

| DB Console area | System-level privilege | Privileged information |
| - | - | - |
| [Databases](https://docs.cockroachlabs.com/docs/stable/ui-databases-page.md) | [`VIEWACTIVITY`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`VIEWACTIVITYREDACTED`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Stored table data |
| [Statements](https://docs.cockroachlabs.com/docs/stable/ui-statements-page.md) | [`VIEWACTIVITY`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`VIEWACTIVITYREDACTED`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | SQL statements |
| [Transactions](https://docs.cockroachlabs.com/docs/stable/ui-transactions-page.md) | [`VIEWACTIVITY`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`VIEWACTIVITYREDACTED`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Transactions |
| [Sessions](https://docs.cockroachlabs.com/docs/stable/ui-sessions-page.md) | [`VIEWACTIVITY`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`VIEWACTIVITYREDACTED`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Sessions |
| [Insights](https://docs.cockroachlabs.com/docs/stable/ui-insights-page.md) | [`VIEWACTIVITY`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`VIEWACTIVITYREDACTED`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Insights |
| [Hot Ranges](https://docs.cockroachlabs.com/docs/stable/ui-hot-ranges-page) | [`VIEWCLUSTERMETADATA`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Ranges |
| [Jobs](https://docs.cockroachlabs.com/docs/stable/ui-jobs-page.md) | [`VIEWJOB`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Jobs |
| [Advanced Debug](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md) | [`VIEWDEBUG`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Debugging and profiling endpoints |
| [Advanced Debug > Problem Ranges](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md#reports) | [`VIEWCLUSTERMETADATA`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Ranges |
| [Advanced Debug > Data Distribution and Zone Configs](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md#reports) | [`VIEWCLUSTERMETADATA`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Ranges |
| [Advanced Debug > Cluster Settings](https://docs.cockroachlabs.com/docs/stable/ui-debug-pages.md#configuration) | [`VIEWCLUSTERSETTING`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) or [`MODIFYCLUSTERSETTING`](https://docs.cockroachlabs.com/docs/stable/security-reference/authorization) | Cluster Settings |

## DB Console timezone configuration

You can view timestamps in the DB Console in your preferred timezone using the `ui.display_timezone` [cluster setting](https://docs.cockroachlabs.com/docs/stable/cluster-settings.md). Currently supported timezones are Coordinated Universal Time (`etc/utc`, the default) and America/New\_York (`america/new_york`):

```sql theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
SET CLUSTER SETTING ui.display_timezone = 'america/new_york';
```

## DB Console troubleshooting

The DB Console stores temporary data in a time-series database in order to generate the various [metrics](#metrics) graphs. If your cluster is comprised of a large number of nodes where individual nodes have very limited memory available (e.g., under `8 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 [`--max-tsdb-memory`](https://docs.cockroachlabs.com/docs/stable/cockroach-start#flags-max-tsdb-memory) 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 [Diagnostics Reporting](https://docs.cockroachlabs.com/docs/stable/diagnostics-reporting.md).

## License expiration message

If you have [set a license](https://docs.cockroachlabs.com/docs/stable/licensing-faqs.md#set-a-license), a license expiration message is displayed at the top-right of the DB Console. While the license is valid, the message will read `License 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.

## See also

* [Troubleshooting Overview](https://docs.cockroachlabs.com/docs/stable/troubleshooting-overview.md)
* [Support Resources](https://docs.cockroachlabs.com/docs/stable/support-resources.md)
* [Raw Status Endpoints](https://docs.cockroachlabs.com/docs/stable/monitoring-and-alerting.md#raw-status-endpoints)