Skip to content

Update diagnostics page re: telemetry info #19620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update diagnostics page re: telemetry info #19620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9aae08
Update diagnostics page re: telemetry info
rmloveland May 20, 2025
49ed2cb
Change 'hourly' to 'periodic' for maintainability
rmloveland Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions src/current/v23.1/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v23.2/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v24.1/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v24.2/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v24.3/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v25.1/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on an hourly basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
8 changes: 3 additions & 5 deletions src/current/v25.2/diagnostics-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: reference.diagnostics_reporting
---

By default, the DB Console and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
By default, the DB Console and each node of a CockroachDB cluster share usage details with Cockroach Labs. Sensitive data is redacted from this usage information; these details help us understand and improve how the system behaves in real-world scenarios.

This page summarizes the details that get shared, how to view the details yourself, and how to opt out of sharing.

Expand All @@ -15,10 +15,7 @@ For insights into your cluster's performance and health, use the built-in [DB Co

## What gets shared

When diagnostics reporting is on, each node of a CockroachDB cluster shares anonymized details on an hourly basis, including (but not limited to):

- Deployment and configuration characteristics, such as size of hardware, [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}) that have been altered from defaults, number of [replication zones]({% link {{ page.version.version }}/configure-replication-zones.md %}) configured, etc.
- Usage and cluster health details, such as crashes, unexpected errors, attempts to use unsupported features, types of queries run and their execution characteristics as well as types of schemas used, etc.
When diagnostics reporting is on, each node of a CockroachDB cluster shares obfuscated usage details on a periodic basis. For more information about what information is shared, see [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %}).

To view the full diagnostics details that a node reports to Cockroach Labs, use the `http://<node-address>:<http-port>/_status/diagnostics/local` JSON endpoint.

Expand Down Expand Up @@ -67,5 +64,6 @@ If the setting is `false`, diagnostics reporting is off; if the setting is `true

## See also

- [Telemetry Collected by CockroachDB]({% link {{ page.version.version }}/telemetry.md %})
- [Cluster Settings]({% link {{ page.version.version }}/cluster-settings.md %})
- [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %})
Loading