You are viewing the archived documentation of TiDB, which no longer receives updates. View the latest LTS version docs ↗
Sign InStart for Free
TiDB Self-Managed
Sign InStart for Free

DM-worker Configuration File

This document introduces the configuration of DM worker, including a configuration file template and a description of each configuration parameter in this file.

Configuration file template

The following is a configuration file template of the DM-worker:

# Worker Configuration.
name = "worker1"

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

# 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 # New in DM v2.0.2.

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

Configuration parameters

Global

ParameterDescription
nameThe name of the DM-worker.
log-levelSpecifies a log level from debug, info, warn, error, and fatal. The default log level is info.
log-fileSpecifies the log file directory. If this parameter is not specified, the logs are printed onto the standard output.
worker-addrSpecifies the address of DM-worker which provides services. You can omit the IP address and specify the port number only, such as ":8262".
advertise-addrSpecifies the address that DM-worker advertises to the outside world.
joinCorresponds to one or more master-addrs in the DM-master configuration file.
keepalive-ttlThe keepalive time (in seconds) of a DM-worker node to the DM-master node if the upstream data source of the DM-worker node does not enable the relay log. The default value is 60s.
relay-keepalive-ttlThe keepalive time (in seconds) of a DM-worker node to the DM-master node if the upstream data source of the DM-worker node enables the relay log. The default value is 1800s. This parameter is added since DM v2.0.2.
ssl-caThe path of the file that contains list of trusted SSL CAs for DM-worker to connect with other components.
ssl-certThe path of the file that contains X509 certificate in PEM format for DM-worker to connect with other components.
ssl-keyThe path of the file that contains X509 key in PEM format for DM-worker to connect with other components.
cert-allowed-cnCommon Name list.