Skip to content

Commit 4d0e124

Browse files
authored
v25.4 changes to logging channels (#20434)
- In logging-overview.md, (a) added log.channel_compatibility_mode.enabled 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. * Incorporated Kevin’s feedback. * Incorporated Mike’s feedback.
1 parent 3197791 commit 4d0e124

File tree

4 files changed

+65
-10
lines changed

4 files changed

+65
-10
lines changed

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ This page describes how to configure CockroachDB logs with the [`--log` or `log-
1515

1616
For examples of how these settings can be used in practice, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}).
1717

18+
{{site.data.alerts.callout_info}}
19+
In a future major release, certain events will be directed by default to new [logging channels]({% link {{ page.version.version }}/logging-overview.md %}#logging-channels).
20+
21+
To prepare for the change and assess potential downstream impacts on your logging setup and pipelines, review the [`log.channel_compatibility_mode.enabled`]({% link {{ page.version.version }}/logging-overview.md %}#log-channel_compatibility_mode-enabled) cluster setting. After reviewing the documentation, set `log.channel_compatibility_mode.enabled` to `false` in a non-production environment.
22+
{{site.data.alerts.end}}
23+
1824
## Flag
1925

2026
To configure the logging behavior of a `cockroach` command, include one of these flags with the command:
@@ -865,6 +871,19 @@ sinks:
865871
redactable: true
866872
exit-on-error: true
867873
buffering: NONE
874+
kv-exec:
875+
channels: {INFO: [KV_EXEC]}
876+
dir: /cockroach-data/logs
877+
max-file-size: 10MiB
878+
max-group-size: 100MiB
879+
file-permissions: "0640"
880+
buffered-writes: true
881+
filter: INFO
882+
format: crdb-v2
883+
redact: false
884+
redactable: true
885+
exit-on-error: true
886+
buffering: NONE
868887
pebble:
869888
channels: {INFO: [STORAGE]}
870889
dir: /cockroach-data/logs

src/current/v25.4/log-sql-activity-to-datadog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ docs_area: manage
77

88
This tutorial describes how to configure logging of telemetry events, including [`sampled_query`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) and [`sampled_transaction`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query), to [Datadog](https://www.datadoghq.com/) for finer granularity and long-term retention of SQL activity. The `sampled_query` and `sampled_transaction` events contain common SQL event and execution details for [statements]({% link {{ page.version.version }}/sql-statements.md %}) and [transactions]({% link {{ page.version.version }}/transactions.md %}).
99

10+
{{site.data.alerts.callout_info}}
11+
`sampled_query` and `sampled_transaction` events, which are sent by default to the [`TELEMETRY`]({% link {{ page.version.version }}/logging-overview.md %}#telemetry) channel in {{ page.version.version }} and earlier versions, will instead be routed by default to the [`SQL_EXEC`]({% link {{ page.version.version }}/logging-overview.md %}#sql_exec) channel in a future major release.
12+
13+
To prepare for the change and assess potential downstream impacts on your logging setup and pipelines, review the [`log.channel_compatibility_mode.enabled`]({% link {{ page.version.version }}/logging-overview.md %}#log-channel_compatibility_mode-enabled) cluster setting. After reviewing the documentation, set `log.channel_compatibility_mode.enabled` to `false` in a non-production environment to log `sampled_query` and `sampled_transaction` events to the [SQL_EXEC]({% link {{ page.version.version }}/logging-overview.md %}#sql_exec) channel.
14+
{{site.data.alerts.end}}
15+
1016
CockroachDB supports a built-in integration with Datadog which sends these events as logs via the [Datadog HTTP API](https://docs.datadoghq.com/api/latest/logs/). This integration is the recommended path to achieve high throughput data ingestion, which will in turn provide more query and transaction events for greater workload observability.
1117

1218
{{site.data.alerts.callout_info}}

0 commit comments

Comments
 (0)