From f1fa8b1d60e963c5d48d8eff90c8111afdaaa3c0 Mon Sep 17 00:00:00 2001 From: gmhdbjd Date: Fri, 28 Mar 2025 00:02:32 +0800 Subject: [PATCH 1/4] dm: add log redaction configuration item in dm worker log file --- dm/dm-worker-configuration-file.md | 7 +++++++ log-redaction.md | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/dm/dm-worker-configuration-file.md b/dm/dm-worker-configuration-file.md index 06bcd7442916..8553dad9e410 100644 --- a/dm/dm-worker-configuration-file.md +++ b/dm/dm-worker-configuration-file.md @@ -18,6 +18,7 @@ name = "worker1" # Log configuration. log-level = "info" log-file = "dm-worker.log" +redact-info-log = false # DM-worker listen address. worker-addr = ":8262" @@ -52,6 +53,12 @@ cert-allowed-cn = ["dm"] - 日志文件。如果不配置，日志会输出到标准输出中。 +#### `redact-info-log` 从 v9.0 版本开始引入 + +- 日志脱敏。控制是否在日志中记录 DM 查询参数详细信息。 +- 默认值：`false` +- 可选值：`false`、`true` + #### `worker-addr` - DM-worker 服务的地址，可以省略 IP 信息，例如：`":8262"`。 diff --git a/log-redaction.md b/log-redaction.md index e62c826c2a96..22d3b97d80dd 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -70,3 +70,7 @@ PD 侧的日志脱敏需要将 [`security.redact-info-log`](/pd-configuration-fi ## TiFlash 组件日志脱敏 TiFlash 侧的日志脱敏需要将 tiflash-server 中 [`security.redact_info_log`](/tiflash/tiflash-configuration.md#配置文件-tiflashtoml) 配置项的值以及 tiflash-learner 中 [`security.redact-info-log`](/tiflash/tiflash-configuration.md#配置文件-tiflash-learnertoml) 配置项的值均设为 `true` 或者 `"marker"`。两配置项默认值均为 `false`，即关闭脱敏。 + +## DM-worker 组件日志脱敏 + +DM-worker 侧的日志脱敏需要将 [`log.redact-info-log`](/dm/dm-worker-configuration-file.md#redact-info-log-从-v90-版本开始引入) 的值设为 `true`。该配置项值默认为 `false`，即关闭脱敏。 From 03b400ffcb145acad6ab30b0a41cba101dd09aa0 Mon Sep 17 00:00:00 2001 From: GMHDBJD <35025882+GMHDBJD@users.noreply.github.com> Date: Thu, 17 Apr 2025 18:54:56 +0800 Subject: [PATCH 2/4] Update dm/dm-worker-configuration-file.md Co-authored-by: Aolin --- dm/dm-worker-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dm/dm-worker-configuration-file.md b/dm/dm-worker-configuration-file.md index 8553dad9e410..749fbbee3291 100644 --- a/dm/dm-worker-configuration-file.md +++ b/dm/dm-worker-configuration-file.md @@ -53,7 +53,7 @@ cert-allowed-cn = ["dm"] - 日志文件。如果不配置，日志会输出到标准输出中。 -#### `redact-info-log` 从 v9.0 版本开始引入 +#### `redact-info-log` 从 v9.0.0 版本开始引入 - 日志脱敏。控制是否在日志中记录 DM 查询参数详细信息。 - 默认值：`false` From 0f773367cb2e633601cc24640ed7ff3158ced256 Mon Sep 17 00:00:00 2001 From: GMHDBJD <35025882+GMHDBJD@users.noreply.github.com> Date: Thu, 17 Apr 2025 18:55:03 +0800 Subject: [PATCH 3/4] Update dm/dm-worker-configuration-file.md Co-authored-by: Aolin --- dm/dm-worker-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dm/dm-worker-configuration-file.md b/dm/dm-worker-configuration-file.md index 749fbbee3291..1b3820e24359 100644 --- a/dm/dm-worker-configuration-file.md +++ b/dm/dm-worker-configuration-file.md @@ -55,7 +55,7 @@ cert-allowed-cn = ["dm"] #### `redact-info-log` 从 v9.0.0 版本开始引入 -- 日志脱敏。控制是否在日志中记录 DM 查询参数详细信息。 +- 控制是否开启日志脱敏。该配置项值设为 `true` 时对 DM-worker 日志脱敏，隐藏 DM 查询参数的详细信息。具体使用方法参见 [DM-worker 组件日志脱敏](/log-redaction.md#dm-worker-组件日志脱敏)。 - 默认值：`false` - 可选值：`false`、`true` From 58da0e1cf7457970e537072faa8b4467dc102931 Mon Sep 17 00:00:00 2001 From: GMHDBJD <35025882+GMHDBJD@users.noreply.github.com> Date: Thu, 17 Apr 2025 19:31:20 +0800 Subject: [PATCH 4/4] Update log-redaction.md --- log-redaction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/log-redaction.md b/log-redaction.md index 22d3b97d80dd..f93279007b3c 100644 --- a/log-redaction.md +++ b/log-redaction.md @@ -73,4 +73,4 @@ TiFlash 侧的日志脱敏需要将 tiflash-server 中 [`security.redact_info_lo ## DM-worker 组件日志脱敏 -DM-worker 侧的日志脱敏需要将 [`log.redact-info-log`](/dm/dm-worker-configuration-file.md#redact-info-log-从-v90-版本开始引入) 的值设为 `true`。该配置项值默认为 `false`，即关闭脱敏。 +DM-worker 侧的日志脱敏需要将 [`log.redact-info-log`](/dm/dm-worker-configuration-file.md#redact-info-log-从-v900-版本开始引入) 的值设为 `true`。该配置项值默认为 `false`，即关闭脱敏。