util/log,cli: new TELEMETRY channel

[jseldess]

Jesse Seldess (jseldess) commented:

PR: https://github.com/cockroachdb/cockroach/pull/66427

From release notes:

CockroachDB now supports a new logging channel called TELEMETRY. This will be used in later versions to report diagnostic events useful to Cockroach Labs for product analytics. (At the time of this writing, no events are defined for the TELEMETRY channel yet.) When no logging configuration is specified, this channel is connected to file output, with a maximum retention of 1MiB. To also produce the diagnostic output elsewhere, one can [define a new sink](../v21.2/configure-logs.html] that captures this channel. For example, to see diagnostics reports on the standard error, one can use: --log='sinks: {stderr: {channels: TELEMETRY, filter: INFO}}' When configuring file output, the operator should be careful to apply a separate maximum retention for the TELEMETRY channel from other file outputs, as telemetry data can be verbose and outcrowd other logging messages. For example: --log='sinks: {file-groups: {telemetry: {channels: TELEMETRY, max-group-size: 1MB}, ...}}. [#66427][#66427)

Jira Issue: DOC-1359

[exalate-issue-sync[bot]]

Tommy Truongchau (thtruo) commented: Andrew Feierabend i believe this is a no op, but will assign to you for investigating

[exalate-issue-sync[bot]]

Andrew Feierabend (andf-crl) commented: Looked into this. As of the originating PR, there were no logging events that use the TELEMETRY log channel. Since then, two have been added:

• {{captured_index_usage_stats}}
• {{sampled_query}}

Present in both v21.2 and v22.1. Part of generated content directly here.

The {{TELEMETRY}} log event channel is already minimally presented per the usual upstream generated docs content here and here.

However, while the PR makes an interesting note about being careful to configure a sane maximum retention for one’s TELEMETRY-channel-configured log sink, this in practice really only seems relevant for CC engineers (i.e. CRL employees). Use of the word ‘operator’ in PR desc further seems to confirm.

As such, this does indeed appear to be a no-op. Closing ticket.