From f522020e9b30dbbfcd9a31d44aff40bae38e9246 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Wed, 30 Sep 2026 10:29:15 +0800 Subject: [PATCH 1/5] docs: add TiCDC log redaction configuration --- log-redaction.md | 10 +++++++++- ticdc/ticdc-server-config.md | 8 +++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/log-redaction.md b/log-redaction.md index 1d5b86f56e358..7686f7efff3da 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -71,6 +71,14 @@ To enable log redaction in the PD side, set the value of [`security.redact-info- To enable log redaction in the TiFlash side, set both the [`security.redact_info_log`](/tiflash/tiflash-configuration.md#configure-the-tiflashtoml-file) value in tiflash-server and the [`security.redact-info-log`](/tiflash/tiflash-configuration.md#configure-the-tiflash-learnertoml-file) value in tiflash-learner to `true` or `"marker"`. Both configuration values default to `false`, which means that log redaction is disabled. +## Log redaction in TiCDC + +> **Note:** +> +> Starting from TiCDC v8.5.6, log redaction is supported only in the TiCDC new architecture. + +To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in markers. + ## Log redaction in DM-worker side -To enable log redaction in the DM-worker side, set the value of [`log.redact-info-log`](/dm/dm-worker-configuration-file.md#redact-info-log-new-in-v900) to `true`. This configuration value defaults to `false`, which means that log redaction is disabled. +To enable log redaction in the DM-worker side, set the value of [`log.redact-info-log`](/dm/dm-worker-configuration-file.md#redact-info-log-new-in-v900) to `true`. This configuration value defaults to `false`, which means that log redaction is disabled. \ No newline at end of file diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index e6599f6ee978f..d6747384d92a3 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -107,6 +107,12 @@ The following describes the configuration file specified by the `config` option +#### `redact-info-log` New in v8.5.6 + +- Controls log redaction. This parameter is supported only in the [TiCDC new architecture](/ticdc/ticdc-architecture.md). +- Default value: `false`, which disables log redaction +- Set the value to `true` to replace sensitive values in logs with `?`, or set it to `"marker"` to enclose sensitive values in markers. + ### `capture-session-ttl` - Specifies the session duration between TiCDC and etcd services. This parameter is optional. @@ -181,4 +187,4 @@ The following describes the configuration file specified by the `config` option - You can configure this parameter in two ways: - Specify only the number, for example, `50000000` represents 50000000 nanoseconds (50 milliseconds) - Specify both the number and the unit, for example, `50ms` -- Default value: `60000000000` (1 minute) +- Default value: `60000000000` (1 minute) \ No newline at end of file From 35f59b77d439a0e09f52c49b62d8c14b1661d1cb Mon Sep 17 00:00:00 2001 From: dongmen <414110582@qq.com> Date: Thu, 29 Oct 2026 19:25:29 +0800 Subject: [PATCH 2/5] docs: fix TiCDC log redaction link anchor --- log-redaction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/log-redaction.md b/log-redaction.md index 7686f7efff3da..0f1c02d7de0c6 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -77,7 +77,7 @@ To enable log redaction in the TiFlash side, set both the [`security.redact_info > > Starting from TiCDC v8.5.6, log redaction is supported only in the TiCDC new architecture. -To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in markers. +To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log-new-in-v856) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in markers. ## Log redaction in DM-worker side From 5530bbff5c2261c7e3ce46e61e92cf76bb0862f5 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 30 Oct 2026 09:46:27 +0800 Subject: [PATCH 3/5] Update log-redaction.md Co-authored-by: Grace Cai --- log-redaction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/log-redaction.md b/log-redaction.md index 0f1c02d7de0c6..97e11f41bc600 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -77,7 +77,7 @@ To enable log redaction in the TiFlash side, set both the [`security.redact_info > > Starting from TiCDC v8.5.6, log redaction is supported only in the TiCDC new architecture. -To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log-new-in-v856) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in markers. +To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log-new-in-v856) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in `‹` and `›` while preserving their original values. ## Log redaction in DM-worker side From ae421ac0a5e1edfac50e536447c22229fed09a98 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 30 Oct 2026 09:46:35 +0800 Subject: [PATCH 4/5] Update log-redaction.md Co-authored-by: Grace Cai --- log-redaction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/log-redaction.md b/log-redaction.md index 97e11f41bc600..529a579f5ee8d 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -75,7 +75,7 @@ To enable log redaction in the TiFlash side, set both the [`security.redact_info > **Note:** > -> Starting from TiCDC v8.5.6, log redaction is supported only in the TiCDC new architecture. +> Starting from TiCDC v8.5.6, log redaction is supported only in the [TiCDC new architecture](/ticdc/ticdc-architecture.md). To enable log redaction in TiCDC, set [`security.redact-info-log`](/ticdc/ticdc-server-config.md#redact-info-log-new-in-v856) to `true` in the TiCDC server configuration file. This parameter defaults to `false`, which means that log redaction is disabled. When you set it to `true`, TiCDC replaces sensitive values in logs with `?`. Alternatively, set it to `"marker"` to enclose sensitive values in `‹` and `›` while preserving their original values. From 273798a002e970a72154a2918b689297a1729b23 Mon Sep 17 00:00:00 2001 From: dongmen <20351731+asddongmen@users.noreply.github.com> Date: Fri, 30 Oct 2026 09:46:42 +0800 Subject: [PATCH 5/5] Update ticdc/ticdc-server-config.md Co-authored-by: Grace Cai --- ticdc/ticdc-server-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index d6747384d92a3..fd03577090b62 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -111,7 +111,7 @@ The following describes the configuration file specified by the `config` option - Controls log redaction. This parameter is supported only in the [TiCDC new architecture](/ticdc/ticdc-architecture.md). - Default value: `false`, which disables log redaction -- Set the value to `true` to replace sensitive values in logs with `?`, or set it to `"marker"` to enclose sensitive values in markers. +- Set the value to `true` to replace sensitive values in logs with `?`, or set it to `"marker"` to enclose sensitive values in `‹` and `›` while preserving their original values. ### `capture-session-ttl`