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.

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 1 commit into
base: main
Choose a base branch
from

Conversation

rmloveland
Copy link
Contributor

Fixes DOC-13703

Summary of changes:

  • Replace mentions of 'anonymous' with 'obfuscated/redacted'

  • Remove mention of details, and point users to the 'Telemetry Collected by CockroachDB' page, which is intended to be the comprehensive reference

Fixes DOC-13703

Summary of changes:

- Replace mentions of 'anonymous' with 'obfuscated/redacted'

- Remove mention of details, and point users to the 'Telemetry Collected
  by CockroachDB' page, which is intended to be the comprehensive
  reference
@rmloveland rmloveland requested review from kevin-v-ngo and jaiayu May 20, 2025 16:04
Copy link

netlify bot commented May 20, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit c9aae08
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/682ca80204c6310008bb3ab9

Copy link

netlify bot commented May 20, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit c9aae08
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/682ca802afdf2300088a3b50

@rmloveland
Copy link
Contributor Author

@kevin-v-ngo adding you to review so you're informed, not sure if this needs review beyond @jaiayu since we discussed on Slack a bit but y'all please let me know!

Copy link

netlify bot commented May 20, 2025

Deploy Preview for cockroachdb-docs failed. Why did it fail? →

Name Link
🔨 Latest commit c9aae08
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/682ca8026ae8920009c85457

@rmloveland
Copy link
Contributor Author

@jaiayu what do you think of this one? happy to update if you have any feedback


- 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 %}).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmloveland @kevin-v-ngo -- confirming that it's hourly? I could be misremembering but I thought it was more frequent

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it was an hour unless we updated with the CORE changes. @dhartunian, can you confirm?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this feels very implementation-tied and fragile to maintain, any objection to updating this to say "shares obfuscated usage details on a periodic basis" ?

Copy link

@jaiayu jaiayu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rmloveland! LGTM! Just had one question on the frequency of reporting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants