Skip to content

Commit 9394643

Browse files
committed
Fix memory arbitrator links and wording
Update documentation references to use the new "memory arbitrator" naming and corrected anchor targets. Changed cross-doc links in configure-memory-usage.md and system-variables.md (e.g. tidb_mem_arbitrator_mode anchor, memory-arbitrator-mode anchor, and the high-memory alarm anchor) so they point to the renamed headings introduced for v9.0.0 and ensure consistent phrasing across the docs.
1 parent 7537d20 commit 9394643

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

configure-memory-usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ To verify the performance of `GOMEMLIMIT`, a test is performed to compare the sp
228228

229229
## Memory arbitrator mode
230230

231-
Before TiDB v9.0.0, the [memory control mechanism](#how-to-configure-the-memory-usage-threshold-of-a-tidb-server-instance) has the following issues:
231+
Before TiDB v9.0.0, the [memory control mechanism](#configure-the-memory-usage-threshold-of-a-tidb-server-instance) has the following issues:
232232

233233
- When the memory usage of a TiDB instance exceeds the limit, TiDB might randomly terminate running SQL statements.
234234
- Memory resources follow a “use-then-report” mechanism, and memory usage is isolated across different SQL statements. As a result, TiDB cannot centrally schedule or control memory resources at the instance level.
@@ -240,13 +240,13 @@ Starting from v9.0.0, TiDB introduces memory arbitrator mode. This mode introduc
240240
>
241241
> This feature is experimental and is not recommended for use in the production environment. This feature might be changed or removed without prior notice. If you find a bug, report it by submitting an [issue](https://github.com/pingcap/tidb/issues) on GitHub.
242242

243-
You can enable memory arbitrator mode using the [`tidb_mem_arbitrator_mode`](/system-variables.md#tidb_mem_arbitrator_mode-introduced-in-v900) system variable or the `instance.tidb_mem_arbitrator_mode` parameter in the TiDB configuration file.
243+
You can enable memory arbitrator mode using the [`tidb_mem_arbitrator_mode`](/system-variables.md#tidb_mem_arbitrator_mode-new-in-v900) system variable or the `instance.tidb_mem_arbitrator_mode` parameter in the TiDB configuration file.
244244

245245
- `disable`: disables memory arbitrator mode
246246

247247
- `standard` or `priority`: enables memory arbitrator mode. After it is enabled:
248248
- Memory resources are used with a subscribe-before-allocation mechanism and are uniformly scheduled by the memory arbitrator in each TiDB instance.
249-
- The overall memory usage of the TiDB instance is expected not to exceed the limit of [`tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640), and the [alarm for high memory usage](#alarm-for-high-memory-usage-of-tidb-server) no longer takes effect.
249+
- The overall memory usage of the TiDB instance is expected not to exceed the limit of [`tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640), and the [alarm for high memory usage](#trigger-the-alarm-of-excessive-memory-usage) no longer takes effect.
250250
- The behavior of the following system variables remains effective:
251251
- [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action-new-in-v610)
252252
- [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query)

system-variables.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4020,10 +4020,10 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
40204020
- Type: Enum
40214021
- Default value: `disable`
40224022
- Possible values: `disable`, `standard`, `priority`
4023-
- This variable sets the memory management mode of a TiDB instance. For more information, see [TiDB memory control](/configure-memory-usage.md#memory-arbitration-mode). The following values are supported:
4024-
- `disable` (default): Disables memory arbitration mode and keeps the mechanism of [use first and report later](/system-variables.md#tidb_server_memory_limit-new-in-v640).
4025-
- `standard`: Enables standard memory arbitration mode. When SQL needs to use memory resources, it first subscribes to the memory arbitrator and allocates memory resources only after the subscription succeeds. If the subscription fails, the SQL execution is terminated.
4026-
- `priority`: Enables priority-based memory arbitration mode. When SQL needs to use memory resources, it first subscribes to the memory arbitrator and allocates memory resources only after the subscription succeeds. TiDB handles memory resource subscription requests according to the SQL [resource group priority](/information-schema/information-schema-resource-groups.md).
4023+
- This variable sets the memory management mode of a TiDB instance. For more information, see [TiDB memory control](/configure-memory-usage.md#memory-arbitrator-mode). The following values are supported:
4024+
- `disable` (default): Disables memory arbitrator mode and keeps the mechanism of [use first and report later](/system-variables.md#tidb_server_memory_limit-new-in-v640).
4025+
- `standard`: Enables standard memory arbitrator mode. When SQL needs to use memory resources, it first subscribes to the memory arbitrator and allocates memory resources only after the subscription succeeds. If the subscription fails, the SQL execution is terminated.
4026+
- `priority`: Enables priority-based memory arbitrator mode. When SQL needs to use memory resources, it first subscribes to the memory arbitrator and allocates memory resources only after the subscription succeeds. TiDB handles memory resource subscription requests according to the SQL [resource group priority](/information-schema/information-schema-resource-groups.md).
40274027

40284028
### `tidb_mem_arbitrator_query_reserved` <span class="version-mark">New in v9.0.0</span>
40294029

@@ -4037,7 +4037,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
40374037
- Default value: `0`
40384038
- Unit: Bytes
40394039
- Range: `[0, 9223372036854775807]`
4040-
- When [memory arbitration mode](/configure-memory-usage.md#memory-arbitration-mode) is enabled, this variable controls the amount of memory resources that SQL pre-subscribes to from the memory arbitrator before execution. For more information, see [TiDB memory control](/configure-memory-usage.md#manually-ensuring-memory-safety).
4040+
- When [memory arbitrator mode](/configure-memory-usage.md#memory-arbitrator-mode) is enabled, this variable controls the amount of memory resources that SQL pre-subscribes to from the memory arbitrator before execution. For more information, see [TiDB memory control](/configure-memory-usage.md#manually-ensuring-memory-safety).
40414041

40424042
### `tidb_mem_arbitrator_soft_limit` <span class="version-mark">New in v9.0.0</span>
40434043

@@ -4051,7 +4051,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
40514051
- Type: String
40524052
- Default value: `0`
40534053
- Possible values: `0`, floating-point number `(0, 1]`, integer `(1, 9223372036854775807]`
4054-
- When [memory arbitration mode](/configure-memory-usage.md#memory-arbitration-mode) is enabled, this variable controls the upper limit of memory resources that the arbitrator can allocate in a TiDB instance. For more information, see [TiDB memory control](/configure-memory-usage.md#manually-ensuring-memory-safety).
4054+
- When [memory arbitrator mode](/configure-memory-usage.md#memory-arbitrator-mode) is enabled, this variable controls the upper limit of memory resources that the arbitrator can allocate in a TiDB instance. For more information, see [TiDB memory control](/configure-memory-usage.md#manually-ensuring-memory-safety).
40554055
- `0`: The default upper limit of memory resources is `95%` of the value of [`tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640)
40564056
- Floating-point number `(0, 1]`: Specifies the upper limit of memory resources as a ratio relative to [`tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640). For example, `0.8` means the upper limit of memory resources is `tidb_server_memory_limit * 0.8`.
40574057
- Integer `(1, 9223372036854775807]`: Specifies the number of bytes
@@ -4067,7 +4067,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
40674067
- Type: Enum
40684068
- Default value: `0`
40694069
- Possible values: `0`, `1`, `nolimit`
4070-
- When [memory arbitration mode](/configure-memory-usage.md#memory-arbitration-mode) is enabled, this variable controls the behavior of SQL when waiting for memory resources. For more information, see [TiDB memory control](/configure-memory-usage.md#memory-arbitration-mode).
4070+
- When [memory arbitrator mode](/configure-memory-usage.md#memory-arbitrator-mode) is enabled, this variable controls the behavior of SQL when waiting for memory resources. For more information, see [TiDB memory control](/configure-memory-usage.md#memory-arbitrator-mode).
40714071
- `0` (default): Disables this feature, and the variable does not take effect
40724072
- `1`: Takes effect only in `priority` mode. SQL is automatically bound to high priority when subscribing to memory resources. When global memory resources are insufficient, the SQL execution is terminated instead of being blocked waiting.
40734073
- `nolimit`: The memory usage of SQL is not limited by the arbitrator. This value might increase the risk of OOM on the TiDB instance.

0 commit comments

Comments
 (0)