Skip to content

dm-worker-configuration-file.md

Latest commit

 

History

History
104 lines (65 loc) · 3.2 KB

dm-worker-configuration-file.md

File metadata and controls

104 lines (65 loc) · 3.2 KB
title DM-worker 配置文件介绍
aliases
/docs-cn/tidb-data-migration/dev/dm-worker-configuration-file/
summary 本文介绍了 DM-worker 的配置文件，包括配置文件示例和配置项说明。配置文件示例包括了 worker 的名称、日志配置、worker 的地址等内容。配置项说明包括了全局配置中的各个配置项的说明，如 name、log-level、log-file 等。同时还介绍了一些新增的配置项，如 relay-keepalive-ttl 和 relay-dir。SSL 相关的配置项也有详细说明。

DM-worker 配置文件介绍

本文介绍 DM-worker 的配置文件，包括配置文件示例与配置项说明。

配置文件示例

# Worker Configuration.

name = "worker1"

# Log configuration.
log-level = "info"
log-file = "dm-worker.log"
redact-info-log = false

# DM-worker listen address.
worker-addr = ":8262"
advertise-addr = "127.0.0.1:8262"
join = "http://127.0.0.1:8261,http://127.0.0.1:8361,http://127.0.0.1:8461"

keepalive-ttl = 60
relay-keepalive-ttl = 1800 # 版本 2.0.2 新增
# relay-dir = "relay_log" # 版本 5.4.0 新增。使用相对路径时注意结合部署、启动方式确认路径位置。

ssl-ca = "/path/to/ca.pem"
ssl-cert = "/path/to/cert.pem"
ssl-key = "/path/to/key.pem"
cert-allowed-cn = ["dm"]

配置项说明

Global 配置

name

  • 标识一个 DM-worker。

log-level

  • 日志级别。
  • 默认值：info
  • 可选值：debug、info、warn、error、fatal

log-file

  • 日志文件。如果不配置，日志会输出到标准输出中。

redact-info-log 从 v9.0.0 版本开始引入

  • 控制是否开启日志脱敏。该配置项值设为 true 时对 DM-worker 日志脱敏，隐藏 DM 查询参数的详细信息。具体使用方法参见 DM-worker 组件日志脱敏。
  • 默认值：false
  • 可选值：false、true

worker-addr

  • DM-worker 服务的地址，可以省略 IP 信息，例如：":8262"。

advertise-addr

  • DM-worker 向外界宣告的地址。

join

  • 对应一个或多个 DM-master 配置中的 master-addr。

keepalive-ttl

  • 当绑定的上游数据源没有启用 relay log 时，DM-worker 向 DM-master 保持存活的周期。
  • 默认值：60
  • 单位：秒

relay-keepalive-ttl 从 v2.0.2 版本开始引入

  • 当绑定的上游数据源启用 relay log 时，DM-worker 向 DM-master 保持存活的周期。
  • 默认值：1800
  • 单位：秒

relay-dir 从 v5.4.0 版本开始引入

  • 当绑定的上游数据源启用 relay log 时，DM-worker 将 relay log 保存在该路径下。该配置优先级比上游数据源配置更高。

ssl-ca

  • DM-worker 组件用于与其它组件连接的 SSL CA 证书所在的路径。

ssl-cert

  • DM-worker 组件用于与其它组件连接的 PEM 格式的 X509 证书所在的路径。

ssl-key

  • DM-worker 组件用于与其它组件连接的 PEM 格式的 X509 密钥所在的路径。

cert-allowed-cn

  • 证书检查 Common Name 列表。