This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 5fff6f63c89 refine queue doc (#1624)
5fff6f63c89 is described below
commit 5fff6f63c8938a32e3e6d190c481f1cae853b487
Author: yiguolei <[email protected]>
AuthorDate: Thu Dec 26 13:38:58 2024 +0800
refine queue doc (#1624)
## Versions
- [x] dev
- [ ] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [ ] English
## Docs Checklist
- [x] Checked by AI
- [ ] Test Cases Built
---------
Co-authored-by: yiguolei <[email protected]>
---
.../concurrency-control-and-queuing.md | 131 ---------------------
.../concurrency-control-and-queuing.md | 103 ++++++++++++++++
2 files changed, 103 insertions(+), 131 deletions(-)
diff --git
a/docs/admin-manual/workload-management/concurrency-control-and-queuing.md
b/docs/admin-manual/workload-management/concurrency-control-and-queuing.md
index 361205f4d2c..e69de29bb2d 100644
--- a/docs/admin-manual/workload-management/concurrency-control-and-queuing.md
+++ b/docs/admin-manual/workload-management/concurrency-control-and-queuing.md
@@ -1,131 +0,0 @@
----
-{
-"title": "并发控制与排队",
-"language": "zh-CN"
-}
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-线上环境难免出现负载高峰耗尽集群的资源导致集群整体可用性下降的情况，通过Workload
Group功能固然可以把高峰负载分组的资源用量降下来，但是这个分组内的查询可能由于资源耗尽导致查询失败或者超时，
-因此 Workload Group 支持查询的并发控制和排队的功能，当分组内查询数到达最大并发之后，新来的查询会进入排队的逻辑，保证了查询的稳定性。
-
-## 参数说明
-* max_concurrency：最大查询并发数，默认值为整型最大值，也就是不做并发的限制。运行中的查询数量达到该值时，新来的查询会进入排队的逻辑。
-
-* max_queue_size：查询排队队列的长度，当排队队列已满时，新来的查询会被拒绝。默认值为 0，含义是不排队，当查询数达到最大时查询会直接失败。
-
-* queue_timeout：查询在排队队列中的超时时间，单位为毫秒，如果查询在队列中的排队时间超过这个值，那么就会直接抛出异常给客户端。默认值为
0，含义是不排队，查询进入队列后立即返回失败。
-
-## 基本使用
-```
-create workload group if not exists queue_group
-properties (
- "max_concurrency" = "10",
- "max_queue_size" = "20",
- "queue_timeout" = "3000"
-);
-```
-如果集群中目前有1台FE，那么这个配置的含义为，集群中同时运行的查询数最大不超过10个，当最大并发已满时，新来的查询会排队，队列的长度不超过20。查询在队列中排队的时间最长为3s，排队超过3s的查询会直接返回失败给客户端。
-
-:::tip
-目前的排队设计是不感知 FE 的个数的，排队的参数只在单 FE 粒度生效，例如：
-
-一个 Doris 集群配置了一个 work load group，设置 max_concurrency = 1；
-如果集群中有 1FE，那么这个 workload group 在 Doris 集群视角看同时只会运行一个 SQL；
-如果有 3 台 FE，那么在 Doris 集群视角看最大可运行的 SQL 个数为 3 。
-:::
-
-### 查看排队状态
-```running_query_num```代表运行中的查询数量，```waiting_query_num```代表排队中的查询数量
-```
-mysql [(none)]>show workload groups\G;
-*************************** 1. row ***************************
- Id: 1
- Name: normal
- cpu_share: 20
- memory_limit: 50%
- enable_memory_overcommit: true
- max_concurrency: 2147483647
- max_queue_size: 0
- queue_timeout: 0
- cpu_hard_limit: 1%
- scan_thread_num: 16
- max_remote_scan_thread_num: -1
- min_remote_scan_thread_num: -1
- memory_low_watermark: 50%
- memory_high_watermark: 80%
- tag:
- read_bytes_per_second: -1
-remote_read_bytes_per_second: -1
- running_query_num: 0
- waiting_query_num: 0
-```
-
-
-## 绕开排队的逻辑
-在有些运维情况下，管理员账户需要绕开排队的逻辑，那么可以通过设置session变量：
-```
-set bypass_workload_group = true;
-```
-
-## 效果测试
-
-**测试环境**
-
-1FE 1BE
-
-**创建Workload Group**
-```
-create workload group test_queue
- properties
- (
- "max_concurrency" = "2",
- "max_queue_size" = "3",
- "queue_timeout" = "5000"
- )
-```
-
-发起5并发的查询，查看目前的排队情况，可以看到```running_query_num```代表运行中的查询为2，```waiting_query_num```代表排队中的查询数为3
-```
-mysql [information_schema]>show workload groups like '%test_queue%'\G;
-*************************** 1. row ***************************
- Id: 22012
- Name: test_queue
- cpu_share: -1
- memory_limit: -1
- enable_memory_overcommit: true
- max_concurrency: 2
- max_queue_size: 3
- queue_timeout: 5000
- cpu_hard_limit: -1
- scan_thread_num: -1
- max_remote_scan_thread_num: -1
- min_remote_scan_thread_num: -1
- memory_low_watermark: 50%
- memory_high_watermark: 80%
- tag:
- read_bytes_per_second: -1
-remote_read_bytes_per_second: -1
- running_query_num: 2
- waiting_query_num: 3
-1 row in set (0.00 sec)
-```
-
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/concurrency-control-and-queuing.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/concurrency-control-and-queuing.md
index 8b137891791..1ca4295aa37 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/concurrency-control-and-queuing.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/concurrency-control-and-queuing.md
@@ -1 +1,104 @@
+---
+{
+"title": "并发控制与排队",
+"language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+并发控制与排队是一种资源管理机制，当多个查询同时请求资源，达到系统并发能力的上限时，Doris
会根据预设的策略和限制条件对查询进行排队管理，确保系统在高负载情况下仍能平稳运行，避免OOM、系统卡死等问题。
+
+Doris 的并发控制与排队机制主要通过 workload group 来实现。workload group
定义了查询的资源使用上限，包括最大并发数、排队队列长度和超时时间等参数。通过合理配置这些参数，可以达到资源管控的目的。
+
+## 基本使用
+
+```
+create workload group if not exists queue_group
+properties (
+ "max_concurrency" = "10",
+ "max_queue_size" = "20",
+ "queue_timeout" = "3000"
+);
+```
+
+**参数说明**
+
+* max_concurrency：最大查询并发数，默认值为整型最大值，也就是不做并发的限制。运行中的查询数量达到该值时，新来的查询会进入排队的逻辑。
+
+* max_queue_size：查询排队队列的长度，当排队队列已满时，新来的查询会被拒绝。默认值为 0，含义是不排队，当查询数达到最大时查询会直接失败。
+
+* queue_timeout：查询在排队队列中的超时时间，单位为毫秒，如果查询在队列中的排队时间超过这个值，那么就会直接抛出异常给客户端。默认值为
0，含义是不排队，查询进入队列后立即返回失败。
+
+
+如果集群中目前有1台FE，那么这个配置的含义为，集群中同时运行的查询数最大不超过10个，当最大并发已满时，新来的查询会排队，队列的长度不超过20。查询在队列中排队的时间最长为3s，排队超过3s的查询会直接返回失败给客户端。
+
+:::tip
+目前的排队设计是不感知 FE 的个数的，排队的参数只在单 FE 粒度生效，例如：
+
+一个 Doris 集群配置了一个 work load group，设置 max_concurrency = 1；
+如果集群中有 1FE，那么这个 workload group 在 Doris 集群视角看同时只会运行一个 SQL；
+如果有 3 台 FE，那么在 Doris 集群视角看最大可运行的 SQL 个数为 3 。
+:::
+
+## 查看排队状态
+
+**语法**
+
+```
+show workload groups
+```
+
+**示例**
+
+```
+mysql [(none)]>show workload groups\G;
+*************************** 1. row ***************************
+ Id: 1
+ Name: normal
+ cpu_share: 20
+ memory_limit: 50%
+ enable_memory_overcommit: true
+ max_concurrency: 2147483647
+ max_queue_size: 0
+ queue_timeout: 0
+ cpu_hard_limit: 1%
+ scan_thread_num: 16
+ max_remote_scan_thread_num: -1
+ min_remote_scan_thread_num: -1
+ memory_low_watermark: 50%
+ memory_high_watermark: 80%
+ tag:
+ read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+ running_query_num: 0
+ waiting_query_num: 0
+```
+
+```running_query_num```代表运行中的查询数量，```waiting_query_num```代表排队中的查询数量
+
+## 绕开排队的逻辑
+
+在有些运维情况下，管理员账户需要绕开排队的逻辑执行SQL对系统进行一些管理操作，那么可以通过设置session变量，来绕开排队的逻辑：
+
+```
+set bypass_workload_group = true;
+```
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
