diff --git a/log-redaction.md b/log-redaction.md index 1d5b86f56e358..529a579f5ee8d 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](/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. + ## 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..fd03577090b62 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 `‹` and `›` while preserving their original values. + ### `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