Skip to content

docs: add TiCDC log redaction configuration #24097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asddongmen wants to merge 5 commits into
base: master
Choose a base branch
from
Open

docs: add TiCDC log redaction configuration #24097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f522020
docs: add TiCDC log redaction configuration
asddongmen Sep 30, 2026
35f59b7
docs: fix TiCDC log redaction link anchor
asddongmen Oct 29, 2026
5530bbf
Update log-redaction.md
asddongmen Oct 30, 2026
ae421ac
Update log-redaction.md
asddongmen Oct 30, 2026
273798a
Update ticdc/ticdc-server-config.md
asddongmen Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion log-redaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 7 additions & 1 deletion ticdc/ticdc-server-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ The following describes the configuration file specified by the `config` option

<!-- Example: `["username_1", "username_2"]` -->

#### `redact-info-log` <span class="version-mark">New in v8.5.6</span>

- 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.
Expand Down Expand Up @@ -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)
Loading