Update tidb-configuration and system variables for 6.1 #8689

morgo · 2022-05-19T15:37:15Z

What is changed, added or deleted? (Required)

This updates the tidb configuration file and system variables for pingcap/tidb#33769

I use a script to generate the output, so it includes previous changes in #8442 which is not yet merged.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

ti-chi-bot · 2022-05-19T15:37:17Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

ran-huang

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

sql-prepared-plan-cache.md

system-variables.md

tidb-configuration-file.md

morgo · 2022-05-25T15:25:55Z

releases/release-5.0.0.md

---
-title: What's New in TiDB 5.0
---
-
-# What's New in TiDB 5.0


This file had CRLF line endings, which (I think) broke the linter. I fixed it to LF, but that's creating the large diff.

bb7133 · 2022-05-26T06:53:11Z

dashboard/dashboard-faq.md

@@ -57,7 +57,7 @@ If your deployment tool is TiUP, take the following steps to solve this problem.

 ### An `invalid connection` error is shown on the **Slow Queries** page

-The possible reason is that you have enabled the `prepared-plan-cache` feature of TiDB. As an experimental feature, when enabled, `prepared-plan-cache` might not function properly in specific TiDB versions, which could cause this problem in TiDB Dashboard (and other applications). You can disable `prepared-plan-cache` by updating [TiDB Configuration file](/tidb-configuration-file.md#prepared-plan-cache) to solve this problem.
+The possible reason is that you have enabled the Prepared Plan Cache feature of TiDB. As an experimental feature, when enabled, Prepared Plan Cache might not function properly in specific TiDB versions, which could cause this problem in TiDB Dashboard (and other applications). You can disable Prepared Plan Cache by setting the system variable `tidb_enable_prepared_plan_cache = OFF`.


As an experimental feature, when enabled, Prepared Plan Cache might not function properly in specific TiDB versions

I think we should update this part to declare that prepared plan cache has been GAed since v5.3.0, it could be something like 'before v5.3, Prepared Plan Cache is an experimental feature...' @qw4990 PTAL

I wouldn't recommend it to be honest. It becomes hard to read if the docs tells too much history. The MySQL manual has a policy of removing/rewriting version specific messages as of the next release. So it would document in the v5.3 docs that the feature has GA'ed, but the 5.4 docs would make no mention of this event.

configure-memory-usage.md

Co-authored-by: bb7133 <[email protected]>

Signed-off-by: Ran <[email protected]>

ran-huang

LGTM

bb7133

LGTM

ran-huang · 2022-05-27T04:52:38Z

/remove-status LGT1
/status LGT2

ran-huang · 2022-05-27T04:52:44Z

/merge

ti-chi-bot · 2022-05-27T04:52:46Z

This pull request has been accepted and is ready to merge.

Commit hash: 5e5b61c

ran-huang · 2022-05-30T02:33:14Z

configure-memory-usage.md

@@ -6,58 +6,34 @@ aliases: ['/docs/dev/configure-memory-usage/','/docs/dev/how-to/configure/memory

 # TiDB Memory Control

-Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. In the TiDB configuration file, you can configure the options as below to control TiDB behaviors when the memory quota exceeds the threshold value:
+Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. The system variable [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) specifies the action to take when a query reaches the memory limit:


Suggested change

Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. The system variable [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) specifies the action to take when a query reaches the memory limit:

Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. The system variable [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action) specifies the action to take when a query reaches the memory limit:

@morgo Is this correct?

Yes you are right. it should be tidb_mem_oom_action here.

fixed in #8761

Update tidb-configuration and system variables for 6.1

acefdc6

ti-chi-bot requested a review from TomShawn May 19, 2022 15:37

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 19, 2022

TomShawn assigned CbcWestwolf May 23, 2022

shichun-0415 requested a review from CbcWestwolf May 23, 2022 03:08

ran-huang self-requested a review May 23, 2022 04:01

qw4990 reviewed May 23, 2022

View reviewed changes

sql-prepared-plan-cache.md Outdated Show resolved Hide resolved

ran-huang mentioned this pull request May 25, 2022

system-variables: update instance scope #8442

Closed

16 tasks

ran-huang reviewed May 25, 2022

View reviewed changes

morgo added 2 commits May 25, 2022 08:18

Merge remote-tracking branch 'upstream/master' into new-sysvars

893431d

Address PR feedback

e3c9442

ti-chi-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 25, 2022

Fix line endings

518bc91

ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels May 25, 2022

morgo commented May 25, 2022

View reviewed changes

morgo added 2 commits May 25, 2022 09:32

fix linter

0b7e543

Fix additional references

54e50a1

morgo force-pushed the new-sysvars branch from 3662630 to 54e50a1 Compare May 25, 2022 16:55

ran-huang requested a review from bb7133 May 26, 2022 03:43

bb7133 reviewed May 26, 2022

View reviewed changes

Update configure-memory-usage.md

c14cd46

Co-authored-by: bb7133 <[email protected]>

morgo and others added 2 commits May 26, 2022 16:50

Add links to sysvar page for mem-quota-query

9ddd7db

unify versioning: TiDB 6.1 -> TiDB v6.1.0

5e5b61c

Signed-off-by: Ran <[email protected]>

ran-huang approved these changes May 27, 2022

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label May 27, 2022

ran-huang assigned ran-huang and unassigned CbcWestwolf May 27, 2022

bb7133 approved these changes May 27, 2022

View reviewed changes

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels May 27, 2022

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label May 27, 2022

ti-chi-bot merged commit d583448 into pingcap:master May 27, 2022

ran-huang mentioned this pull request May 27, 2022

update doc for memory management of prepared plan cache #8749

Merged

13 tasks

ran-huang reviewed May 30, 2022

View reviewed changes

morgo deleted the new-sysvars branch May 30, 2022 02:43

ran-huang mentioned this pull request May 30, 2022

update tidb config and sys vars for v6.1 pingcap/docs-cn#9631

Merged

13 tasks

ran-huang added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels May 30, 2022

shichun-0415 mentioned this pull request Jan 9, 2023

remove useless description for mem control pingcap/docs-cn#8227

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update tidb-configuration and system variables for 6.1 #8689

Update tidb-configuration and system variables for 6.1 #8689

morgo commented May 19, 2022

ti-chi-bot commented May 19, 2022 •

edited

Loading

morgo May 25, 2022 •

edited

Loading

bb7133 May 26, 2022

morgo May 26, 2022

ran-huang left a comment

bb7133 left a comment

ran-huang commented May 27, 2022

ran-huang commented May 27, 2022

ti-chi-bot commented May 27, 2022

ran-huang May 30, 2022

morgo May 30, 2022

ran-huang May 30, 2022

	Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. The system variable [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) specifies the action to take when a query reaches the memory limit:
	Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. The system variable [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action) specifies the action to take when a query reaches the memory limit:

Update tidb-configuration and system variables for 6.1 #8689

Update tidb-configuration and system variables for 6.1 #8689

Conversation

morgo commented May 19, 2022

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

ti-chi-bot commented May 19, 2022 • edited Loading

morgo May 25, 2022 • edited Loading

Choose a reason for hiding this comment

bb7133 May 26, 2022

Choose a reason for hiding this comment

morgo May 26, 2022

Choose a reason for hiding this comment

ran-huang left a comment

Choose a reason for hiding this comment

bb7133 left a comment

Choose a reason for hiding this comment

ran-huang commented May 27, 2022

ran-huang commented May 27, 2022

ti-chi-bot commented May 27, 2022

ran-huang May 30, 2022

Choose a reason for hiding this comment

morgo May 30, 2022

Choose a reason for hiding this comment

ran-huang May 30, 2022

Choose a reason for hiding this comment

ti-chi-bot commented May 19, 2022 •

edited

Loading

morgo May 25, 2022 •

edited

Loading