Update diagnostics page re: telemetry info #19620
Conversation
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
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed: |
|
@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! |
❌ Deploy Preview for cockroachdb-docs failed. Why did it fail? →
|
|
@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 %}). |
There was a problem hiding this comment.
@rmloveland @kevin-v-ngo -- confirming that it's hourly? I could be misremembering but I thought it was more frequent
There was a problem hiding this comment.
I thought it was an hour unless we updated with the CORE changes. @dhartunian, can you confirm?
There was a problem hiding this comment.
this feels very implementation-tied and fragile to maintain, any objection to updating this to say "shares obfuscated usage details on a periodic basis" ?
There was a problem hiding this comment.
Thanks @rmloveland! LGTM! Just had one question on the frequency of reporting
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