Skip to content

Commit 8798d41

Browse files
kvchkvch
authored
Add warning about setup.template.overwrite to documentation and reference configuration (#22357)
## What does this PR do? This PR adds a warning about `setup.template.overwrite` option. ## Why is it important? Users might enable this option and then start multiple instances of Beats at the same time. This can overload Elasticsearch with too many template update requests.
1 parent 120f931 commit 8798d41

17 files changed

Lines changed: 36 additions & 1 deletion

‎auditbeat/auditbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1177,6 +1177,8 @@ output.elasticsearch:
11771177
#setup.template.json.name: ""
11781178

11791179
# Overwrite existing template
1180+
# Do not enable this option for more than one instance of auditbeat as it might
1181+
# overload your Elasticsearch with too many update requests.
11801182
#setup.template.overwrite: false
11811183

11821184
# Elasticsearch template settings

‎filebeat/filebeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2043,6 +2043,8 @@ output.elasticsearch:
20432043
#setup.template.json.name: ""
20442044

20452045
# Overwrite existing template
2046+
# Do not enable this option for more than one instance of filebeat as it might
2047+
# overload your Elasticsearch with too many update requests.
20462048
#setup.template.overwrite: false
20472049

20482050
# Elasticsearch template settings

‎heartbeat/heartbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,6 +1354,8 @@ output.elasticsearch:
13541354
#setup.template.json.name: ""
13551355

13561356
# Overwrite existing template
1357+
# Do not enable this option for more than one instance of heartbeat as it might
1358+
# overload your Elasticsearch with too many update requests.
13571359
#setup.template.overwrite: false
13581360

13591361
# Elasticsearch template settings

‎journalbeat/journalbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1119,6 +1119,8 @@ output.elasticsearch:
11191119
#setup.template.json.name: ""
11201120

11211121
# Overwrite existing template
1122+
# Do not enable this option for more than one instance of journalbeat as it might
1123+
# overload your Elasticsearch with too many update requests.
11221124
#setup.template.overwrite: false
11231125

11241126
# Elasticsearch template settings

‎libbeat/_meta/config/setup.template.reference.yml.tmpl‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@
4040
#setup.template.json.name: ""
4141

4242
# Overwrite existing template
43+
# Do not enable this option for more than one instance of {{.BeatName}} as it might
44+
# overload your Elasticsearch with too many update requests.
4345
#setup.template.overwrite: false
4446

4547
# Elasticsearch template settings

‎libbeat/docs/howto/load-index-templates.asciidoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ If the template already exists, it’s not overwritten unless you configure
4848
[[overwrite-template]]
4949
=== Overwrite an existing index template
5050

51+
WARNING: Do not enable this option for more than one instance of {beatname_uc}. If you start
52+
multiple instances at the same time, it can overload your {es} with too many
53+
template update requests.
54+
5155
To overwrite a template that's already loaded into {es}, set:
5256

5357
[source,yaml]

‎libbeat/docs/template-config.asciidoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ relative path is set, it is considered relative to the config path. See the <<di
6060
section for details.
6161

6262
*`setup.template.overwrite`*:: A boolean that specifies whether to overwrite the existing template. The default
63-
is false.
63+
is false. Do not enable this option is you start more than one instance of {beatname_uc} at the same time. It
64+
can overload your {es} by sending too many template update reqests.
6465

6566
*`setup.template.settings`*:: A dictionary of settings to place into the `settings.index` dictionary of the
6667
Elasticsearch template. For more details about the available Elasticsearch mapping options, please

‎metricbeat/metricbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1945,6 +1945,8 @@ output.elasticsearch:
19451945
#setup.template.json.name: ""
19461946

19471947
# Overwrite existing template
1948+
# Do not enable this option for more than one instance of metricbeat as it might
1949+
# overload your Elasticsearch with too many update requests.
19481950
#setup.template.overwrite: false
19491951

19501952
# Elasticsearch template settings

‎packetbeat/packetbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1616,6 +1616,8 @@ output.elasticsearch:
16161616
#setup.template.json.name: ""
16171617

16181618
# Overwrite existing template
1619+
# Do not enable this option for more than one instance of packetbeat as it might
1620+
# overload your Elasticsearch with too many update requests.
16191621
#setup.template.overwrite: false
16201622

16211623
# Elasticsearch template settings

‎winlogbeat/winlogbeat.reference.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,6 +1099,8 @@ output.elasticsearch:
10991099
#setup.template.json.name: ""
11001100

11011101
# Overwrite existing template
1102+
# Do not enable this option for more than one instance of winlogbeat as it might
1103+
# overload your Elasticsearch with too many update requests.
11021104
#setup.template.overwrite: false
11031105

11041106
# Elasticsearch template settings

0 commit comments

Comments
 (0)