Skip to content

Commit 4e2e5aa

Browse files
authored
DOC-14177 Document that it is not possible to “disable a logging channel” (#20158)
* Added log-channel-note.md include file to document that log channels can not be disabled. * Incorporated Joe’s feedback. * Copied changes to v24.3, v25.1, v25.2.
1 parent 025dded commit 4e2e5aa

File tree

12 files changed

+28
-0
lines changed

12 files changed

+28
-0
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{site.data.alerts.callout_info}}
2+
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.
3+
{{site.data.alerts.end}}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{site.data.alerts.callout_info}}
2+
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.
3+
{{site.data.alerts.end}}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{site.data.alerts.callout_info}}
2+
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.
3+
{{site.data.alerts.end}}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{site.data.alerts.callout_info}}
2+
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.
3+
{{site.data.alerts.end}}

src/current/v24.3/configure-logs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any
293293

294294
### Logging channel selection
295295

296+
{% include {{ page.version.version }}/log-channel-note.md %}
297+
296298
For each sink, multiple channels can be selected. Note that:
297299

298300
- Spacing between items will vary according to the syntax used.

src/current/v24.3/logging-overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands
2222

2323
## Logging channels
2424

25+
{% include {{ page.version.version }}/log-channel-note.md %}
26+
2527
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).
2628

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

src/current/v25.1/configure-logs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any
293293

294294
### Logging channel selection
295295

296+
{% include {{ page.version.version }}/log-channel-note.md %}
297+
296298
For each sink, multiple channels can be selected. Note that:
297299

298300
- Spacing between items will vary according to the syntax used.

src/current/v25.1/logging-overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands
2222

2323
## Logging channels
2424

25+
{% include {{ page.version.version }}/log-channel-note.md %}
26+
2527
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).
2628

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

src/current/v25.2/configure-logs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,8 @@ By default, `cockroach start` and `cockroach start-single-node` do not print any
293293

294294
### Logging channel selection
295295

296+
{% include {{ page.version.version }}/log-channel-note.md %}
297+
296298
For each sink, multiple channels can be selected. Note that:
297299

298300
- Spacing between items will vary according to the syntax used.

src/current/v25.2/logging-overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands
2222

2323
## Logging channels
2424

25+
{% include {{ page.version.version }}/log-channel-note.md %}
26+
2527
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).
2628

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

0 commit comments

Comments
 (0)