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

# Advanced Debug Page

export const InternalLink = ({version, path = "", children, ...props}) => {
  let detectedVersion = version || "stable";
  if (typeof window !== 'undefined' && !version) {
    const match = window.location.pathname.match(/\/docs\/([^/]+)/);
    if (match) {
      detectedVersion = match[1];
    }
  }
  const normalizedPath = path.startsWith("/") ? path.slice(1) : path;
  return <a href={`/docs/${detectedVersion}/${normalizedPath}`} {...props}>
      {children}
    </a>;
};

<Note>
  On a <InternalLink path="secure-a-cluster">secure cluster</InternalLink>, you must be an `admin` user to access this area of the DB Console. Refer to <InternalLink path="ui-overview#db-console-access">DB Console security</InternalLink>.
</Note>

The **Advanced Debug** page of the DB Console provides links to advanced monitoring and troubleshooting reports and cluster configuration details. To view this page, <InternalLink path="ui-overview#db-console-access">access the DB Console</InternalLink> and click **Advanced Debug** in the left-hand navigation.

<Note>
  These pages are experimental and largely undocumented. If you find an issue, let us know through [these channels](https://www.cockroachlabs.com/community).
</Note>

## Required privileges

To view the **Advanced Debug** page, and work with the debugging and profiling endpoints hosted on this page, the user must be a member of the `admin` role or must have the `VIEWDEBUG` <InternalLink path="security-reference/authorization#supported-privileges">system privilege</InternalLink> defined.

## License and node information

On the right-side of the page, the following information is displayed:

* <InternalLink path="licensing-faqs">**License type**</InternalLink>: Determines if you have access to Enterprise features.
* **Web server**: Indicates the node currently serving your DB Console web session, and allows you to select a different node if desired. To cancel your selection of a different node, click **Reset**. You may also specify this directly in the URL with the `remote_node_id` parameter. For example, use `http://<host:<http-port/?remote_node_id=2` to select node `2`. The node selected here is also set as the target node for the **Profiling UI** section.

## Reports

The following debug reports are useful for monitoring and troubleshooting CockroachDB:

| Report                                                                                  | Description                                                                                                                                      | Access level                                                                                                                                                                                                                                                                                                                                  |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <InternalLink path="ui-custom-chart-debug-page">Custom Time Series Chart</InternalLink> | Create a custom chart of time series data.                                                                                                       | All users.                                                                                                                                                                                                                                                                                                                                    |
| Problem Ranges                                                                          | View ranges in your cluster that are unavailable, under-replicated, slow, paused, or have other problems.                                        | On secure clusters, <InternalLink path="security-reference/authorization#admin-role">`admin` user</InternalLink> or a SQL user with the <InternalLink path="security-reference/authorization">`VIEWCLUSTERMETADATA`</InternalLink><InternalLink path="security-reference/authorization#supported-privileges">system privilege</InternalLink>. |
| Data Distribution and Zone Configs                                                      | View the distribution of table data across nodes and verify <InternalLink path="configure-replication-zones">zone configurations</InternalLink>. | On secure clusters, <InternalLink path="security-reference/authorization#admin-role">`admin` user</InternalLink> or a SQL user with the <InternalLink path="security-reference/authorization">`VIEWCLUSTERMETADATA`</InternalLink><InternalLink path="security-reference/authorization#supported-privileges">system privilege</InternalLink>. |
| Statement Diagnostics History                                                           | Diagnostic bundles for all statements executed on the cluster.                                                                                   | On secure clusters, <InternalLink path="security-reference/authorization#admin-role">`admin` user</InternalLink> only.                                                                                                                                                                                                                        |

## Configuration

The following configuration settings are useful for monitoring and troubleshooting CockroachDB:

| Configuration    | Description                                        | Access level                                           |
| ---------------- | -------------------------------------------------- | ------------------------------------------------------ |
| 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.            | All users.                                             |

## Even More Advanced Debugging

The **Even More Advanced Debugging** section of the page lists advanced troubleshooting tools and reports that are generally of interest to CockroachDB developers and contributors, such as the <InternalLink path="ui-key-visualizer">Key Visualizer</InternalLink>, a tool for visualizing read and write traffic across your keyspace.

If you want to learn more about the tools in this section, contact us through [these channels](https://www.cockroachlabs.com/community).

## Raw Status Endpoints (JSON)

<Note>
  These endpoints are deprecated in favor of the <InternalLink path="monitoring-and-alerting#cluster-api">Cluster API</InternalLink>.
</Note>

Depending on your <InternalLink path="ui-overview#db-console-access">access level</InternalLink>, the endpoints listed here provide access to:

* <InternalLink path="logging-overview">Log files</InternalLink>
* Metrics
* Node status
* Hot ranges
* Node-specific metrics
* Session data
* Cluster-wide range data
* Allocator runs

## See also

* <InternalLink path="troubleshooting-overview">Troubleshooting Overview</InternalLink>
* <InternalLink path="support-resources">Support Resources</InternalLink>
* <InternalLink path="monitoring-and-alerting#raw-status-endpoints">Raw Status Endpoints</InternalLink>
