From 08bcecd5624d49048ad22078c03e6cafdd3b5b19 Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Mon, 29 Jun 2026 09:41:07 +0900 Subject: [PATCH 1/2] config: fix heading hierarchy for sub-section levels MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change sub-section headings from ## to ### to properly reflect the config key hierarchy: - ## log.file → ### log.file (child of ## log) - ## opentracing.sampler → ### opentracing.sampler - ## opentracing.reporter → ### opentracing.reporter - ## tikv-client.copr-cache → ### tikv-client.copr-cache --- tidb-configuration-file.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 4192947980ba6..bdbf026cab7d1 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -350,7 +350,7 @@ Configuration items related to log. - Unit: second - In some user scenarios, TiDB logs might be stored on hot-pluggable or network-attached disks, which might become permanently unavailable. In these cases, TiDB cannot recover automatically from such disaster and the log-writing operations will be permanently blocked. Although the TiDB process might seem to be running, it does not respond to any requests. This configuration item is designed to handle such situations. -## log.file +### log.file Configuration items related to log files. @@ -666,7 +666,7 @@ Configuration items related to opentracing. + Enables RPC metrics. + Default value: `false` -## opentracing.sampler +### opentracing.sampler Configuration items related to opentracing.sampler. @@ -700,7 +700,7 @@ Configuration items related to opentracing.sampler. + Controls the frequency of polling the jaeger-agent sampling policy. + Default value: `0` -## opentracing.reporter +### opentracing.reporter Configuration items related to opentracing.reporter. @@ -820,7 +820,7 @@ Configuration items related to opentracing.reporter. + Whether to use the new version of the Region replica selector when sending RPC requests to TiKV. + Default value: `true` -## tikv-client.copr-cache New in v4.0.0 +### tikv-client.copr-cache New in v4.0.0 This section introduces configuration items related to the [Coprocessor Cache](/coprocessor-cache.md) feature. From cfd283e6628ba5274b22fbd7bd973581d72c9e50 Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Mon, 29 Jun 2026 09:49:05 +0900 Subject: [PATCH 2/2] fixup! promote child parameter headings to #### under promoted sections --- tidb-configuration-file.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index bdbf026cab7d1..206ea136f5fbd 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -670,13 +670,13 @@ Configuration items related to opentracing. Configuration items related to opentracing.sampler. -### `type` +#### `type` + Specifies the type of the opentracing sampler. The string value is case-insensitive. + Default value: `"const"` + Value options: `"const"`, `"probabilistic"`, `"ratelimiting"`, `"remote"` -### `param` +#### `param` + The parameter of the opentracing sampler. - For the `const` type, the value can be `0` or `1`, which indicates whether to enable the `const` sampler. @@ -685,17 +685,17 @@ Configuration items related to opentracing.sampler. - For the `remote` type, the parameter specifies the sampling probability, which can be a float number between `0` and `1`. + Default value: `1.0` -### `sampling-server-url` +#### `sampling-server-url` + The HTTP URL of the jaeger-agent sampling server. + Default value: `""` -### `max-operations` +#### `max-operations` + The maximum number of operations that the sampler can trace. If an operation is not traced, the default probabilistic sampler is used. + Default value: `0` -### `sampling-refresh-interval` +#### `sampling-refresh-interval` + Controls the frequency of polling the jaeger-agent sampling policy. + Default value: `0` @@ -704,22 +704,22 @@ Configuration items related to opentracing.sampler. Configuration items related to opentracing.reporter. -### `queue-size` +#### `queue-size` + The queue size with which the reporter records spans in memory. + Default value: `0` -### `buffer-flush-interval` +#### `buffer-flush-interval` + The interval at which the reporter flushes the spans in memory to the storage. + Default value: `0` -### `log-spans` +#### `log-spans` + Determines whether to print the log for all submitted spans. + Default value: `false` -### `local-agent-host-port` +#### `local-agent-host-port` + The address at which the reporter sends spans to the jaeger-agent. + Default value: `""` @@ -824,7 +824,7 @@ Configuration items related to opentracing.reporter. This section introduces configuration items related to the [Coprocessor Cache](/coprocessor-cache.md) feature. -### `capacity-mb` +#### `capacity-mb` - The total size of the cached data. When the cache space is full, old cache entries are evicted. When the value is `0.0`, the Coprocessor Cache feature is disabled. - Default value: `1000.0`