From 0f24cfd191d76e8608e1891f052e5b4eb36f46c4 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 11 Oct 2023 11:16:23 +0800 Subject: [PATCH 1/7] Add temp.md --- temp.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 temp.md diff --git a/temp.md b/temp.md new file mode 100644 index 0000000000000..af27ff4986a7b --- /dev/null +++ b/temp.md @@ -0,0 +1 @@ +This is a test file. \ No newline at end of file From 098f3cadfb4d89a80d19e5211ecf56d5eea7f315 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 11 Oct 2023 11:16:28 +0800 Subject: [PATCH 2/7] Delete temp.md --- temp.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 temp.md diff --git a/temp.md b/temp.md deleted file mode 100644 index af27ff4986a7b..0000000000000 --- a/temp.md +++ /dev/null @@ -1 +0,0 @@ -This is a test file. \ No newline at end of file From 892bf5f8ce3fc8954600a928da152c586c53b613 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 11 Oct 2023 13:56:03 +0800 Subject: [PATCH 3/7] add translation --- ticdc/ticdc-server-config.md | 46 +++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index 4f48585b3e2ad..205d757fb9ca4 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -31,6 +31,7 @@ The following are descriptions of options available in a `cdc server` command: The following are configurations in the configuration file of `cdc server`: ```yaml +# The configuration method of the following parameters is the same as that of CLI parameters, but the CLI parameters have higher priorities. addr = "127.0.0.1:8300" advertise-addr = "" log-file = "" @@ -45,30 +46,37 @@ cluster-id = "default" cert-path = "" key-path = "" - +# The session duration between TiCDC and etcd services, measured in seconds. This parameter is optional and its default value is 10. capture-session-ttl = 10 # 10s + +# The interval at which the Owner module in the TiCDC cluster attempts to push the replication progress. This parameter is optional and its default value is `50000000` nanoseconds (that is, 50 milliseconds). You can configure this parameter in two ways: specifying only the number (for example, configuring it as `40000000` represents 40000000 nanoseconds, which is 40 milliseconds), or specifying both the number and unit (for example, directly configuring it as `40ms`). owner-flush-interval = 50000000 # 50 ms + +# The interval at which the Processor module in the TiCDC cluster attempts to push the replication progress. This parameter is optional and its default value is `50000000` nanoseconds (that is, 50 milliseconds). The configuration method of this parameter is the same as that of `owner-flush-interval`. processor-flush-interval = 50000000 # 50 ms -per-table-memory-quota = 10485760 # 10 MiB -[log] - error-output = "stderr" - [log.file] - max-size = 300 # 300 MiB - max-days = 0 - max-backups = 0 +#[log] +# The output location for internal error logs of the zap log module. This parameter is optional and its default value is "stderr". +# error-output = "stderr" +# [log.file] +# The maximum size of a single log file, measured in MiB. This parameter is optional and its default value is 300. +# max-size = 300 # 300 MiB +# The maximum number of days to retain log files. This parameter is optional and its default value is `0`, indicating never to delete. +# max-days = 0 +# The number of log files to retain. This parameter is optional and its default value is `0`, indicating to keep all log files. +# max-backups = 0 -[sorter] - num-concurrent-worker = 4 - chunk-size-limit = 999 - max-memory-percentage = 30 - max-memory-consumption = 17179869184 - num-workerpool-goroutine = 16 - sort-dir = "/tmp/sorter" +#[sorter] +# The size of the shared pebble block cache in the Sorter module for the 8 pebble DBs started by default, measured in MiB. The default value is 128. +# cache-size-in-mb = 128 +# The directory where sorter files are stored relative to the data directory. This parameter is optional and its default value is "/tmp/sorter". +# sorter-dir = "/tmp/sorter" # [kv-client] -# worker-concurrent = 8 -# worker-pool-size = 0 -# region-scan-limit = 40 -# region-retry-duration = 60000000000 +# The number of threads that can be used in a single Region worker. This parameter is optional and its default value is 8. +# worker-concurrent = 8 +# The number of threads in the shared thread pool of TiCDC, mainly used for processing KV events. This parameter is optional and its default value is 0, indicating that the default pool size is twice the number of CPU cores. +# worker-pool-size = 0 +# The retry time of Region connection. This parameter is optional and its default value is `60000000000` nanoseconds (that is, 1 minute). You can configure this parameter in two ways: specifying only the number (for example, configuring it as `50000000` represents 50000000 nanoseconds, which is 50 milliseconds), or specifying both the number and unit (for example, directly configuring it as `50ms`). +# region-retry-duration = 60000000000 ``` From b75f1e84b1e66e0a85f266687a6539e11fc08798 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 11 Oct 2023 14:05:43 +0800 Subject: [PATCH 4/7] Update ticdc/ticdc-server-config.md --- ticdc/ticdc-server-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index 205d757fb9ca4..c286f8e40269c 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -77,6 +77,6 @@ processor-flush-interval = 50000000 # 50 ms # worker-concurrent = 8 # The number of threads in the shared thread pool of TiCDC, mainly used for processing KV events. This parameter is optional and its default value is 0, indicating that the default pool size is twice the number of CPU cores. # worker-pool-size = 0 -# The retry time of Region connection. This parameter is optional and its default value is `60000000000` nanoseconds (that is, 1 minute). You can configure this parameter in two ways: specifying only the number (for example, configuring it as `50000000` represents 50000000 nanoseconds, which is 50 milliseconds), or specifying both the number and unit (for example, directly configuring it as `50ms`). +# The retry duration of Region connections. This parameter is optional and its default value is `60000000000` nanoseconds (that is, 1 minute). You can configure this parameter in two ways: specifying only the number (for example, configuring it as `50000000` represents 50000000 nanoseconds, which is 50 milliseconds), or specifying both the number and unit (for example, directly configuring it as `50ms`). # region-retry-duration = 60000000000 ``` From affc0788ea3395694536040490964940625c87d7 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 13 Oct 2023 10:58:49 +0800 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Aolin --- ticdc/ticdc-server-config.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index c286f8e40269c..765be3c5a378b 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -28,9 +28,9 @@ The following are descriptions of options available in a `cdc server` command: ## `cdc server` configuration file parameters -The following are configurations in the configuration file of `cdc server`: +The following describes the configuration file specified by the `config` option in the `cdc server` command: -```yaml +```toml # The configuration method of the following parameters is the same as that of CLI parameters, but the CLI parameters have higher priorities. addr = "127.0.0.1:8300" advertise-addr = "" @@ -55,16 +55,16 @@ owner-flush-interval = 50000000 # 50 ms # The interval at which the Processor module in the TiCDC cluster attempts to push the replication progress. This parameter is optional and its default value is `50000000` nanoseconds (that is, 50 milliseconds). The configuration method of this parameter is the same as that of `owner-flush-interval`. processor-flush-interval = 50000000 # 50 ms -#[log] -# The output location for internal error logs of the zap log module. This parameter is optional and its default value is "stderr". -# error-output = "stderr" -# [log.file] -# The maximum size of a single log file, measured in MiB. This parameter is optional and its default value is 300. -# max-size = 300 # 300 MiB -# The maximum number of days to retain log files. This parameter is optional and its default value is `0`, indicating never to delete. -# max-days = 0 -# The number of log files to retain. This parameter is optional and its default value is `0`, indicating to keep all log files. -# max-backups = 0 +# [log] +# # The output location for internal error logs of the zap log module. This parameter is optional and its default value is "stderr". +# error-output = "stderr" +# [log.file] +# # The maximum size of a single log file, measured in MiB. This parameter is optional and its default value is 300. +# max-size = 300 # 300 MiB +# # The maximum number of days to retain log files. This parameter is optional and its default value is `0`, indicating never to delete. +# max-days = 0 +# # The number of log files to retain. This parameter is optional and its default value is `0`, indicating to keep all log files. +# max-backups = 0 #[sorter] # The size of the shared pebble block cache in the Sorter module for the 8 pebble DBs started by default, measured in MiB. The default value is 128. From f8c9ffb89a79152625ee76cf74d7493a1d8b4384 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 16 Oct 2023 17:17:06 +0800 Subject: [PATCH 6/7] Update ticdc/ticdc-server-config.md Co-authored-by: Aolin --- ticdc/ticdc-server-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index 765be3c5a378b..4425cb7b5ace4 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -69,7 +69,7 @@ processor-flush-interval = 50000000 # 50 ms #[sorter] # The size of the shared pebble block cache in the Sorter module for the 8 pebble DBs started by default, measured in MiB. The default value is 128. # cache-size-in-mb = 128 -# The directory where sorter files are stored relative to the data directory. This parameter is optional and its default value is "/tmp/sorter". +# The directory where sorter files are stored relative to the data directory (`data-dir`). This parameter is optional and its default value is "/tmp/sorter". # sorter-dir = "/tmp/sorter" # [kv-client] From fdf42d86d743f5cbe34733d91256cd6a6b76d127 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 1 Dec 2023 13:29:28 +0800 Subject: [PATCH 7/7] Update ticdc/ticdc-server-config.md --- ticdc/ticdc-server-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-server-config.md b/ticdc/ticdc-server-config.md index 4425cb7b5ace4..40df7fb04d22a 100644 --- a/ticdc/ticdc-server-config.md +++ b/ticdc/ticdc-server-config.md @@ -66,7 +66,7 @@ processor-flush-interval = 50000000 # 50 ms # # The number of log files to retain. This parameter is optional and its default value is `0`, indicating to keep all log files. # max-backups = 0 -#[sorter] +# [sorter] # The size of the shared pebble block cache in the Sorter module for the 8 pebble DBs started by default, measured in MiB. The default value is 128. # cache-size-in-mb = 128 # The directory where sorter files are stored relative to the data directory (`data-dir`). This parameter is optional and its default value is "/tmp/sorter".