You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _tuning-your-cluster/cluster-manager-task-throttling.md
+54-52Lines changed: 54 additions & 52 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ For many cluster state updates, such as defining a mapping or creating an index,
11
11
12
12
The first line of defense is to implement mechanisms in the caller nodes to avoid task overload on the cluster manager. However, even with those mechanisms in place, the cluster manager needs a built-in way to protect itself: cluster manager task throttling.
13
13
14
-
To turn on cluster manager task throttling, you need to set throttling limits. The cluster manager uses the throttling limits to determine whether to reject a task.
14
+
By default, the cluster manager uses predefined throttling limits to determine whether to reject a task. You can modify these limits or disable throttling for specific task types.
15
15
16
16
The cluster manager rejects a task based on its type. For any incoming task, the cluster manager evaluates the total number of tasks of the same type in the pending task queue. If this number exceeds the threshold for this task type, the cluster manager rejects the incoming task. Rejecting a task does not affect tasks of a different type. For example, if the cluster manager rejects a `put-mapping` task, it can still accept a subsequent `create-index` task.
17
17
@@ -21,7 +21,7 @@ When the cluster manager rejects a task, the node performs retries with exponent
21
21
22
22
You can set throttling limits by specifying them in the `cluster_manager.throttling.thresholds` object and updating the [OpenSearch cluster settings]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings). The setting is dynamic, so you can change the behavior of this feature without restarting your cluster.
23
23
24
-
By default, throttling is disabled for all task types.
24
+
By default, throttling is enabled for all task types. To disable throttling for a specific task type, set its threshold value to `-1`.
25
25
{: .note}
26
26
27
27
The request has the following format:
@@ -32,58 +32,65 @@ PUT _cluster/settings
32
32
"persistent": {
33
33
"cluster_manager.throttling.thresholds" : {
34
34
"<task-type>" : {
35
-
"value" : <threshold limit>
35
+
"value" : <threshold>
36
36
}
37
37
}
38
38
}
39
39
}
40
40
```
41
41
42
-
The following table describes the `cluster_manager.throttling.thresholds` object.
42
+
The `cluster_manager.throttling.thresholds` object contains the following fields.
43
43
44
-
Field Name | Description
44
+
Field name | Description
45
45
:--- | :---
46
-
task-type | The task type. See [supported task types](#supported-task-types) for a list of valid values.
47
-
value | The maximum number of tasks of the `task-type` type in the cluster manager's pending task queue. Default is `-1` (no task throttling).
48
-
49
-
## Supported task types
50
-
51
-
The following task types are supported:
52
-
53
-
-`create-index`
54
-
-`update-settings`
55
-
-`cluster-update-settings`
56
-
-`auto-create`
57
-
-`delete-index`
58
-
-`delete-dangling-index`
59
-
-`create-data-stream`
60
-
-`remove-data-stream`
61
-
-`rollover-index`
62
-
-`index-aliases`
63
-
-`put-mapping`
64
-
-`create-index-template`
65
-
-`remove-index-template`
66
-
-`create-component-template`
67
-
-`remove-component-template`
68
-
-`create-index-template-v2`
69
-
-`remove-index-template-v2`
70
-
-`put-pipeline`
71
-
-`delete-pipeline`
72
-
-`create-persistent-task`
73
-
-`finish-persistent-task`
74
-
-`remove-persistent-task`
75
-
-`update-task-state`
76
-
-`put-script`
77
-
-`delete-script`
78
-
-`put-repository`
79
-
-`delete-repository`
80
-
-`create-snapshot`
81
-
-`delete-snapshot`
82
-
-`update-snapshot-state`
83
-
-`restore-snapshot`
84
-
-`cluster-reroute-api`
85
-
86
-
#### Example request
46
+
`<task-type>` | The task type. For a list of valid task types, see [supported task types and default thresholds](#supported-task-types-and-default-thresholds).
47
+
`<task-type>.value` | The maximum number of tasks of the `task-type` type in the cluster manager's pending task queue. <br> For default thresholds for each task type, see [Supported task types and default thresholds](#supported-task-types-and-default-thresholds).
48
+
49
+
## Supported task types and default thresholds
50
+
51
+
The following table lists all supported task types and their default throttling threshold values.
52
+
53
+
Task type | Threshold
54
+
:--- | :---
55
+
`create-index `| 50
56
+
`update-settings` | 50
57
+
`cluster-update-settings` | 50
58
+
`auto-create` | 200
59
+
`delete-index` | 50
60
+
`delete-dangling-index `| 50
61
+
`create-data-stream` | 50
62
+
`remove-data-stream` | 50
63
+
`rollover-index` | 200
64
+
`index-aliases` | 200
65
+
`put-mapping` | 10000
66
+
`create-index-template` | 50
67
+
`remove-index-template` | 50
68
+
`create-component-template` | 50
69
+
`remove-component-template` | 50
70
+
`create-index-template-v2` | 50
71
+
`remove-index-template-v2` | 50
72
+
`put-pipeline` | 50
73
+
`delete-pipeline` | 50
74
+
`put-search-pipeline` | 50
75
+
`delete-search-pipeline` | 50
76
+
`create-persistent-task` | 50
77
+
`finish-persistent-task` | 50
78
+
`remove-persistent-task` | 50
79
+
`update-task-state` | 50
80
+
`create-query-group` | 50
81
+
`delete-query-group` | 50
82
+
`update-query-group` | 50
83
+
`put-script` | 50
84
+
`delete-script` | 50
85
+
`put-repository` | 50
86
+
`delete-repository` | 50
87
+
`create-snapshot` | 50
88
+
`delete-snapshot` | 50
89
+
`update-snapshot-state` | 5000
90
+
`restore-snapshot` | 50
91
+
`cluster-reroute-api` | 50
92
+
93
+
## Example request
87
94
88
95
The following request sets the throttling threshold for the `put-mapping` task type to 100:
89
96
@@ -99,9 +106,4 @@ PUT _cluster/settings
99
106
}
100
107
}
101
108
```
102
-
103
-
Set the threshold to `-1` to disable throttling for a task type.
0 commit comments