v25.4 changes to logging channels #20434
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…led section, (b) updated Logging channels table with notes with link to log.channel_compatibility_mode.enabled, and (c) updated Log destinations table. In configure-logs.md, logging-use-cases.md, and log-sql-activity-to-datadog, added note with link to log.channel_compatibility_mode.enabled. In configure-logs.md, added kv-exec to Default logging configuration.
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
kyle-a-wong
approved these changes
Oct 6, 2025
kevin-v-ngo
reviewed
Oct 21, 2025
| | [`SENSITIVE_ACCESS`]({% link {{ page.version.version }}/logging.md %}#sensitive_access) | SQL audit events (when enabled via [`ALTER TABLE ... EXPERIMENTAL_AUDIT`]({% link {{ page.version.version }}/alter-table.md %}#experimental_audit)). | | ||
| | [`SESSIONS`]({% link {{ page.version.version }}/logging.md %}#sessions) | Client connections and disconnections (when enabled via the `server.auth_log.sql_connections.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %})); SQL authentication logins/attempts and session/query terminations (when enabled via the `server.auth_log.sql_sessions.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %})). | | ||
| | <a id="sql_exec"></a>[`SQL_EXEC`]({% link {{ page.version.version }}/logging.md %}#sql_exec) | SQL statement executions (when enabled via the `sql.trace.log_statement_execute` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %})) and uncaught Go panic errors during SQL statement execution.<br><br>**Warning**: Logging cluster-wide executions by enabling the `sql.trace.log_statement_execute` cluster setting will incur considerable overhead and may have a negative performance impact.<br><br>**Note**: In a future release, the following events will be routed to this channel:<ul><li>[SQL Slow Query Log]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log)</li><li>[SQL Slow Query Log (Internal)]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log-internal)</li><li>[`sampled_query` ]({% link {{ page.version.version }}/eventlog.md %}#sampled_query)</li><li>[`sampled_transaction`]({% link {{ page.version.version }}/eventlog.md %}#sampled_transaction)</li></ul>To assess potential downstream impacts on your logging setup and pipelines, set the [`log.channel_compatibility_mode.enabled`](#log-channel_compatibility_mode-enabled) cluster setting to `false` in a non-production environment. This will log these events to this `SQL_EXEC` channel. | | ||
| | <a id="sql_perf"></a>[`SQL_PERF`]({% link {{ page.version.version }}/logging.md %}#sql_perf) | SQL executions that impact performance, such as slow queries (when enabled via the `sql.log.slow_query.latency_threshold` and/or `sql.log.slow_query.experimental_full_table_scans.enabled` [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %})).<br><br>**Note**: As of v25.4, the `SQL_PERF` and the `SQL_INTERNAL_PERF` channels are **deprecated** and will be removed in a future release. [SQL Slow Query Log]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log) and [SQL Slow Query Log (Internal)]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log-internal) events currently sent to the `SQL_PERF` and [`SQL_INTERNAL_PERF`]({% link {{ page.version.version }}/logging.md %}#sql_internal_perf) channels, respectively, will be routed to the [`SQL_EXEC`](#sql_exec) channel in a future release.<br>To assess potential downstream impacts on your logging setup and pipelines, set the [`log.channel_compatibility_mode.enabled`](#log-channel_compatibility_mode-enabled) cluster setting to `false` in a non-production environment. This will log these events to the [`SQL_EXEC`](#sql_exec) channel. | |
There was a problem hiding this comment.
Nit: We already 'deprecated' SQL PERF so this is cleanup (https://www.cockroachlabs.com/docs/stable/logging#sql_perf)
Can we also call out that internal queries are tagged as "internal" so users can filter out downstream?
|
|
||
| | Channel | Description | | ||
| |-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | <a id="changefeed"></a><span class="version-tag">New in v25.4:</span> [`CHANGEFEED`]({% link {{ page.version.version }}/logging.md %}) | Changefeed events.<br><br>**Note**: [Changefeed telemetry events]({% link {{ page.version.version }}/eventlog.md %}#changefeed-telemetry-events) currently sent to the [`TELEMETRY`](#telemetry) channel will be routed to this channel in a future release.<br>To assess potential downstream impacts on your logging setup and pipelines, set the [`log.channel_compatibility_mode.enabled`](#log-channel_compatibility_mode-enabled) cluster setting to `false` in a non-production environment. This will log these events to this `CHANGEFEED` channel. | |
There was a problem hiding this comment.
Do we provide any details on these events outside of this table?
| | [`DEV`]({% link {{ page.version.version }}/logging.md %}#dev) | Uncategorized and debug messages. | | ||
| | [`OPS`]({% link {{ page.version.version }}/logging.md %}#ops) | Process starts, stops, shutdowns, and crashes (if they can be logged); changes to cluster topology, such as node additions, removals, and decommissions. | | ||
| | [`KV_DISTRIBUTION`]({% link {{ page.version.version }}/logging.md %}#kv_distribution) | Data distribution events, such as moving [replicas]({% link {{ page.version.version }}/architecture/overview.md %}#architecture-replica) between [stores]({% link {{ page.version.version }}/cockroach-start.md %}#store) in a cluster, adding replicas to [ranges]({% link {{ page.version.version }}/architecture/overview.md %}#range), and removing replicas from ranges. | | ||
| | <a id="kv_exec"></a><span class="version-tag">New in v25.4:</span> [`KV_EXEC`]({% link {{ page.version.version }}/logging.md %}) | KV execution events that are not related to distribution.| |
There was a problem hiding this comment.
Do we provide any details on these events outside of this table?
|
|
||
| {% include_cached new-in.html version="v25.4" %} The `log.channel_compatibility_mode.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) when set to: | ||
|
|
||
| - `true` (default): Logs are sent to the expected [logging channels](#logging-channels). Specifically: |
There was a problem hiding this comment.
Nit: Can we call out that this is today's behavior?
| - [SQL Slow Query Log]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log) and [SQL Slow Query Log (Internal)]({% link {{ page.version.version }}/eventlog.md %}#sql-slow-query-log-internal) events are sent to the [`SQL_PERF`](#sql_perf) and [`SQL_INTERNAL_PERF`]({% link {{ page.version.version }}/logging.md %}#sql_internal_perf) channels, respectively. | ||
| - [`sampled_query`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) and [`sampled_transaction`]({% link {{ page.version.version }}/eventlog.md %}#sampled_transaction) events are sent to the [`TELEMETRY`](#telemetry) channel. | ||
|
|
||
| - `false`: Logs are sent to different logging channels as part of the logging channel consolidation effort. Specifically: |
There was a problem hiding this comment.
Logs are sent to the updated logging channels.
Remove "logging channel consolidation effort" users don't know about this
| - [`sampled_query`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) and [`sampled_transaction`]({% link {{ page.version.version }}/eventlog.md %}#sampled_transaction) events are sent to the [`SQL_EXEC`](#sql_exec) channel. | ||
|
|
||
| {{site.data.alerts.callout_danger}} | ||
| In future releases, `log.channel_compatibility_mode.enabled` will default to `false` and then this cluster setting will be removed. To assess potential downstream impacts on your logging setup and pipelines, set the `log.channel_compatibility_mode.enabled` cluster setting to `false` in a non-production environment. |
There was a problem hiding this comment.
Can we just call out that the default behavior will be swapped and users should assess potential downstream impacts on your logging setup and pipelines by setting the log.channel_compatibility_mode.enabled cluster setting to false now to validate?
| Your deployment may use an external service (e.g., [Elasticsearch](https://www.elastic.co/elastic-stack), [Splunk](https://www.splunk.com/)) to collect and programmatically read logging data. | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| In a future release, certain events will be directed to new [logging channels]({% link {{ page.version.version }}/logging-overview.md %}#logging-channels). For more details, refer to [`log.channel_compatibility_mode.enabled`]({% link {{ page.version.version }}/logging-overview.md %}#log-channel_compatibility_mode-enabled). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes DOC-14578 DOC-14617 DOC-14625 DOC-14653
Rendered previews