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: docs/reference/elasticsearch-plugins/index.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,12 @@ mapped_pages:
6
6
7
7
# Elasticsearch plugins [intro]
8
8
9
+
:::{note}
10
+
This section provides detailed **reference information** for Elasticsearch plugins.
11
+
12
+
Refer to [Add plugins and extensions](docs-content://deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
13
+
:::
14
+
9
15
Plugins are a way to enhance the core Elasticsearch functionality in a custom manner. They range from adding custom mapping types, custom analyzers, native scripts, custom discovery and more.
10
16
11
17
Plugins contain JAR files, but may also contain scripts and config files, and must be installed on every node in the cluster. After installation, each node must be restarted before the plugin becomes visible.
@@ -20,7 +24,7 @@ If configured, auditing settings must be set on every node in the cluster. Stati
20
24
21
25
$$$xpack-security-audit-enabled$$$
22
26
23
-
`xpack.security.audit.enabled`
27
+
`xpack.security.audit.enabled`
24
28
: ([Static](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#static-cluster-setting)) Set to `true` to enable auditing on the node. The default value is `false`. This puts the auditing events in a dedicated file named `<clustername>_audit.json` on each node.
25
29
26
30
If enabled, this setting must be configured in `elasticsearch.yml` on all nodes in the cluster.
@@ -33,17 +37,17 @@ The events and some other information about what gets logged can be controlled b
33
37
34
38
$$$xpack-sa-lf-events-include$$$
35
39
36
-
`xpack.security.audit.logfile.events.include`
40
+
`xpack.security.audit.logfile.events.include`
37
41
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies the [kind of events](/reference/elasticsearch/elasticsearch-audit-events.md) to print in the auditing output. In addition, `_all` can be used to exhaustively audit all the events, but this is usually discouraged since it will get very verbose. The default list value contains: `access_denied, access_granted, anonymous_access_denied, authentication_failed, connection_denied, tampered_request, run_as_denied, run_as_granted, security_config_change`.
38
42
39
43
$$$xpack-sa-lf-events-exclude$$$
40
44
41
-
`xpack.security.audit.logfile.events.exclude`
45
+
`xpack.security.audit.logfile.events.exclude`
42
46
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Excludes the specified [kind of events](/reference/elasticsearch/elasticsearch-audit-events.md) from the include list. This is useful in the case where the `events.include` setting contains the special value `_all`. The default is the empty list.
`xpack.security.audit.logfile.events.emit_request_body`
47
51
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the full request body from REST requests as an attribute of certain kinds of audit events. This setting can be used to [audit search queries](docs-content://deploy-manage/monitor/logging-configuration/auditing-search-queries.md).
48
52
49
53
The default value is `false`, so request bodies are not printed.
`xpack.security.audit.logfile.emit_node_name`
62
66
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the [node name](docs-content://deploy-manage/deploy/self-managed/important-settings-configuration.md#node-name) as a field in each audit event. The default value is `false`.
`xpack.security.audit.logfile.emit_node_host_address`
67
71
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node’s IP address as a field in each audit event. The default value is `false`.
`xpack.security.audit.logfile.emit_node_host_name`
72
76
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node’s host name as a field in each audit event. The default value is `false`.
73
77
74
78
$$$xpack-sa-lf-emit-node-id$$$
75
79
76
-
`xpack.security.audit.logfile.emit_node_id`
80
+
`xpack.security.audit.logfile.emit_node_id`
77
81
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node id as a field in each audit event. Unlike [node name](docs-content://deploy-manage/deploy/self-managed/important-settings-configuration.md#node-name), whose value might change if the administrator changes the setting in the config file, the node id will persist across cluster restarts and the administrator cannot change it. The default value is `true`.
78
82
79
83
@@ -83,27 +87,27 @@ The following settings affect the [ignore policies](docs-content://deploy-manage
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.users`
87
91
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of user names or wildcards. The specified policy will not print audit events for users matching these values.
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.realms`
92
96
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of authentication realm names or wildcards. The specified policy will not print audit events for users in these realms.
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.actions`
97
101
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of action names or wildcards. Action name can be found in the `action` field of the audit event. The specified policy will not print audit events for actions matching these values.
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.roles`
102
106
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of role names or wildcards. The specified policy will not print audit events for users that have these roles. If the user has several roles, some of which are **not** covered by the policy, the policy will **not** cover this event.
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.indices`
107
111
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of index names or wildcards. The specified policy will not print audit events when all the indices in the event match these values. If the event concerns several indices, some of which are **not** covered by the policy, the policy will **not** cover this event.
@@ -26,7 +30,7 @@ The parent-level breaker can be configured with the following settings:
26
30
27
31
$$$indices-breaker-total-limit$$$
28
32
29
-
`indices.breaker.total.limit`
33
+
`indices.breaker.total.limit`
30
34
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Starting limit for overall parent breaker. Defaults to 70% of JVM heap if `indices.breaker.total.use_real_memory` is `false`. If `indices.breaker.total.use_real_memory` is `true`, defaults to 95% of the JVM heap.
31
35
32
36
@@ -36,12 +40,12 @@ The field data circuit breaker estimates the heap memory required to load a fiel
36
40
37
41
$$$fielddata-circuit-breaker-limit$$$
38
42
39
-
`indices.breaker.fielddata.limit`
43
+
`indices.breaker.fielddata.limit`
40
44
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Limit for fielddata breaker. Defaults to 40% of JVM heap.
41
45
42
46
$$$fielddata-circuit-breaker-overhead$$$
43
47
44
-
`indices.breaker.fielddata.overhead`
48
+
`indices.breaker.fielddata.overhead`
45
49
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A constant that all field data estimations are multiplied with to determine a final estimation. Defaults to `1.03`.
46
50
47
51
@@ -51,12 +55,12 @@ The request circuit breaker allows Elasticsearch to prevent per-request data str
51
55
52
56
$$$request-breaker-limit$$$
53
57
54
-
`indices.breaker.request.limit`
58
+
`indices.breaker.request.limit`
55
59
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Limit for request breaker, defaults to 60% of JVM heap.
56
60
57
61
$$$request-breaker-overhead$$$
58
62
59
-
`indices.breaker.request.overhead`
63
+
`indices.breaker.request.overhead`
60
64
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A constant that all request estimations are multiplied with to determine a final estimation. Defaults to `1`.
61
65
62
66
@@ -89,7 +93,7 @@ Poorly written regular expressions can degrade cluster stability and performance
89
93
90
94
$$$script-painless-regex-enabled$$$
91
95
92
-
`script.painless.regex.enabled`
96
+
`script.painless.regex.enabled`
93
97
: ([Static](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#static-cluster-setting)) Enables regex in Painless scripts. Accepts:
`cluster.routing.allocation.disk.threshold_enabled`
169
173
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Defaults to `true`. Set to `false` to disable the disk allocation decider. Upon disabling, it will also remove any existing `index.blocks.read_only_allow_delete` index blocks.
170
174
171
175
$$$cluster-routing-watermark-low$$$
172
176
173
-
`cluster.routing.allocation.disk.watermark.low`
177
+
`cluster.routing.allocation.disk.watermark.low`
174
178
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the low watermark for disk usage. It defaults to `85%`, meaning that {{es}} will not allocate shards to nodes that have more than 85% disk used. It can alternatively be set to a ratio value, e.g., `0.85`. It can also be set to an absolute byte value (like `500mb`) to prevent {{es}} from allocating shards if less than the specified amount of space is available. This setting has no effect on the primary shards of newly-created indices but will prevent their replicas from being allocated.
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the max headroom for the low watermark (in case of a percentage/ratio value). Defaults to 200GB when `cluster.routing.allocation.disk.watermark.low` is not explicitly set. This caps the amount of free space required.
178
182
179
183
$$$cluster-routing-watermark-high$$$
180
184
181
-
`cluster.routing.allocation.disk.watermark.high`
185
+
`cluster.routing.allocation.disk.watermark.high`
182
186
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the high watermark. It defaults to `90%`, meaning that {{es}} will attempt to relocate shards away from a node whose disk usage is above 90%. It can alternatively be set to a ratio value, e.g., `0.9`. It can also be set to an absolute byte value (similarly to the low watermark) to relocate shards away from a node if it has less than the specified amount of free space. This setting affects the allocation of all shards, whether previously allocated or not.
`cluster.routing.allocation.disk.watermark.flood_stage`
196
+
`cluster.routing.allocation.disk.watermark.flood_stage`
193
197
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the flood stage watermark, which defaults to 95%. {{es}} enforces a read-only index block ([`index.blocks.read_only_allow_delete`](/reference/elasticsearch/index-settings/index-block.md)) on every index that has one or more shards allocated on the node, and that has at least one disk exceeding the flood stage. This setting is a last resort to prevent nodes from running out of disk space. The index block is automatically released when the disk utilization falls below the high watermark. Similarly to the low and high watermark values, it can alternatively be set to a ratio value, e.g., `0.95`, or an absolute byte value.
194
198
195
199
@@ -203,10 +207,10 @@ You can’t mix the usage of percentage/ratio values and byte values across the
203
207
204
208
$$$cluster-routing-flood-stage-frozen$$$
205
209
206
-
`cluster.routing.allocation.disk.watermark.flood_stage.frozen`
210
+
`cluster.routing.allocation.disk.watermark.flood_stage.frozen`
207
211
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the flood stage watermark for dedicated frozen nodes, which defaults to 95%.
208
212
209
-
`cluster.routing.allocation.disk.watermark.flood_stage.frozen.max_headroom`
213
+
`cluster.routing.allocation.disk.watermark.flood_stage.frozen.max_headroom`
210
214
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the max headroom for the flood stage watermark (in case of a percentage/ratio value) for dedicated frozen nodes. Defaults to 20GB when `cluster.routing.allocation.disk.watermark.flood_stage.frozen` is not explicitly set. This caps the amount of free space required on dedicated frozen nodes.
0 commit comments