From 02a4cfa9548259ad6b0b749cfefdb6acaa8f1898 Mon Sep 17 00:00:00 2001 From: Florence Morris Date: Tue, 19 Aug 2025 12:00:42 -0400 Subject: [PATCH 1/3] Added log-channel-note.md include file to document that log channels can not be disabled. --- src/current/_includes/v25.3/log-channel-note.md | 3 +++ src/current/v25.3/configure-logs.md | 2 ++ src/current/v25.3/logging-overview.md | 2 ++ 3 files changed, 7 insertions(+) create mode 100644 src/current/_includes/v25.3/log-channel-note.md diff --git a/src/current/_includes/v25.3/log-channel-note.md b/src/current/_includes/v25.3/log-channel-note.md new file mode 100644 index 00000000000..f7889c9f812 --- /dev/null +++ b/src/current/_includes/v25.3/log-channel-note.md @@ -0,0 +1,3 @@ +{{site.data.alerts.callout_info}} +Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that is not configured for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) will be enabled in the `default` file group. +{{site.data.alerts.end}} diff --git a/src/current/v25.3/configure-logs.md b/src/current/v25.3/configure-logs.md index 70e17e3a888..ccb30152a4f 100644 --- a/src/current/v25.3/configure-logs.md +++ b/src/current/v25.3/configure-logs.md @@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any ### Logging channel selection +{% include {{ page.version.version }}/log-channel-note.md %} + For each sink, multiple channels can be selected. Note that: - Spacing between items will vary according to the syntax used. diff --git a/src/current/v25.3/logging-overview.md b/src/current/v25.3/logging-overview.md index 948ff94fdcb..6ff5436246a 100644 --- a/src/current/v25.3/logging-overview.md +++ b/src/current/v25.3/logging-overview.md @@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands ## Logging channels +{% include {{ page.version.version }}/log-channel-note.md %} + Log messages in CockroachDB are directed into logging channels, which can in turn be assigned to output to one or more [log sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks). This allows you to group channels that log related information (e.g., operational, security, or SQL events) into their own sinks. Each sink can output to a predetermined destination where the logs can be collected and parsed. For usage examples, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}). From 745681b1f3532b933bddbac7a77f669acde8c579 Mon Sep 17 00:00:00 2001 From: Florence Morris Date: Thu, 21 Aug 2025 14:38:41 -0400 Subject: [PATCH 2/3] =?UTF-8?q?Incorporated=20Joe=E2=80=99s=20feedback.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/current/_includes/v25.3/log-channel-note.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/current/_includes/v25.3/log-channel-note.md b/src/current/_includes/v25.3/log-channel-note.md index f7889c9f812..df3b8ec8254 100644 --- a/src/current/_includes/v25.3/log-channel-note.md +++ b/src/current/_includes/v25.3/log-channel-note.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_info}} -Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that is not configured for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) will be enabled in the `default` file group. +Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that **is not explicitly configured** for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) **is enabled** in the `default` file group. {{site.data.alerts.end}} From b8a59d5545681a293bb8f9526a18fb161b3992cd Mon Sep 17 00:00:00 2001 From: Florence Morris Date: Thu, 21 Aug 2025 16:57:37 -0400 Subject: [PATCH 3/3] Copied changes to v24.3, v25.1, v25.2. --- src/current/_includes/v24.3/log-channel-note.md | 3 +++ src/current/_includes/v25.1/log-channel-note.md | 3 +++ src/current/_includes/v25.2/log-channel-note.md | 3 +++ src/current/v24.3/configure-logs.md | 2 ++ src/current/v24.3/logging-overview.md | 2 ++ src/current/v25.1/configure-logs.md | 2 ++ src/current/v25.1/logging-overview.md | 2 ++ src/current/v25.2/configure-logs.md | 2 ++ src/current/v25.2/logging-overview.md | 2 ++ 9 files changed, 21 insertions(+) create mode 100644 src/current/_includes/v24.3/log-channel-note.md create mode 100644 src/current/_includes/v25.1/log-channel-note.md create mode 100644 src/current/_includes/v25.2/log-channel-note.md diff --git a/src/current/_includes/v24.3/log-channel-note.md b/src/current/_includes/v24.3/log-channel-note.md new file mode 100644 index 00000000000..df3b8ec8254 --- /dev/null +++ b/src/current/_includes/v24.3/log-channel-note.md @@ -0,0 +1,3 @@ +{{site.data.alerts.callout_info}} +Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that **is not explicitly configured** for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) **is enabled** in the `default` file group. +{{site.data.alerts.end}} diff --git a/src/current/_includes/v25.1/log-channel-note.md b/src/current/_includes/v25.1/log-channel-note.md new file mode 100644 index 00000000000..df3b8ec8254 --- /dev/null +++ b/src/current/_includes/v25.1/log-channel-note.md @@ -0,0 +1,3 @@ +{{site.data.alerts.callout_info}} +Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that **is not explicitly configured** for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) **is enabled** in the `default` file group. +{{site.data.alerts.end}} diff --git a/src/current/_includes/v25.2/log-channel-note.md b/src/current/_includes/v25.2/log-channel-note.md new file mode 100644 index 00000000000..df3b8ec8254 --- /dev/null +++ b/src/current/_includes/v25.2/log-channel-note.md @@ -0,0 +1,3 @@ +{{site.data.alerts.callout_info}} +Log channels cannot be completely disabled. You can configure [how log messages are routed to different sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks) and [adjust verbosity levels]({% link {{ page.version.version }}/configure-logs.md %}#set-logging-levels), but you cannot turn off a log channel entirely. For example, a channel that **is not explicitly configured** for a [file group]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) **is enabled** in the `default` file group. +{{site.data.alerts.end}} diff --git a/src/current/v24.3/configure-logs.md b/src/current/v24.3/configure-logs.md index b641cf757c6..6941bb497bc 100644 --- a/src/current/v24.3/configure-logs.md +++ b/src/current/v24.3/configure-logs.md @@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any ### Logging channel selection +{% include {{ page.version.version }}/log-channel-note.md %} + For each sink, multiple channels can be selected. Note that: - Spacing between items will vary according to the syntax used. diff --git a/src/current/v24.3/logging-overview.md b/src/current/v24.3/logging-overview.md index 948ff94fdcb..6ff5436246a 100644 --- a/src/current/v24.3/logging-overview.md +++ b/src/current/v24.3/logging-overview.md @@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands ## Logging channels +{% include {{ page.version.version }}/log-channel-note.md %} + Log messages in CockroachDB are directed into logging channels, which can in turn be assigned to output to one or more [log sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks). This allows you to group channels that log related information (e.g., operational, security, or SQL events) into their own sinks. Each sink can output to a predetermined destination where the logs can be collected and parsed. For usage examples, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}). diff --git a/src/current/v25.1/configure-logs.md b/src/current/v25.1/configure-logs.md index 70e17e3a888..ccb30152a4f 100644 --- a/src/current/v25.1/configure-logs.md +++ b/src/current/v25.1/configure-logs.md @@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any ### Logging channel selection +{% include {{ page.version.version }}/log-channel-note.md %} + For each sink, multiple channels can be selected. Note that: - Spacing between items will vary according to the syntax used. diff --git a/src/current/v25.1/logging-overview.md b/src/current/v25.1/logging-overview.md index 948ff94fdcb..6ff5436246a 100644 --- a/src/current/v25.1/logging-overview.md +++ b/src/current/v25.1/logging-overview.md @@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands ## Logging channels +{% include {{ page.version.version }}/log-channel-note.md %} + Log messages in CockroachDB are directed into logging channels, which can in turn be assigned to output to one or more [log sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks). This allows you to group channels that log related information (e.g., operational, security, or SQL events) into their own sinks. Each sink can output to a predetermined destination where the logs can be collected and parsed. For usage examples, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}). diff --git a/src/current/v25.2/configure-logs.md b/src/current/v25.2/configure-logs.md index 70e17e3a888..ccb30152a4f 100644 --- a/src/current/v25.2/configure-logs.md +++ b/src/current/v25.2/configure-logs.md @@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any ### Logging channel selection +{% include {{ page.version.version }}/log-channel-note.md %} + For each sink, multiple channels can be selected. Note that: - Spacing between items will vary according to the syntax used. diff --git a/src/current/v25.2/logging-overview.md b/src/current/v25.2/logging-overview.md index 948ff94fdcb..6ff5436246a 100644 --- a/src/current/v25.2/logging-overview.md +++ b/src/current/v25.2/logging-overview.md @@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands ## Logging channels +{% include {{ page.version.version }}/log-channel-note.md %} + Log messages in CockroachDB are directed into logging channels, which can in turn be assigned to output to one or more [log sinks]({% link {{ page.version.version }}/configure-logs.md %}#configure-log-sinks). This allows you to group channels that log related information (e.g., operational, security, or SQL events) into their own sinks. Each sink can output to a predetermined destination where the logs can be collected and parsed. For usage examples, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}).