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/index.asciidoc
+29-17Lines changed: 29 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
:plugin: elasticsearch
2
2
:type: output
3
3
:no_codec:
4
+
:branch: current
4
5
5
6
///////////////////////////////////////////
6
7
START - GENERATED VARIABLES, DO NOT EDIT!
@@ -29,8 +30,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for
29
30
interacting with Elasticsearch. In previous versions it was possible to
30
31
communicate with Elasticsearch through the transport protocol, which is now
31
32
reserved for internal cluster communication between nodes
32
-
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html[communication between nodes].
33
-
Using the https://www.elastic.co/guide/en/elasticsearch/reference/current/java-clients.html[transport protocol]
33
+
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-transport.html[communication between nodes].
34
+
Using the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/java-clients.html[transport protocol]
34
35
to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and
35
36
will be removed in 8.0.0
36
37
@@ -91,7 +92,10 @@ Each Elasticsearch output is a new client connected to the cluster:
91
92
* it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients)
92
93
* it has an associated connection pool
93
94
94
-
In order to minimize the number of open connections to Elasticsearch, maximize the bulk size and reduce the number of "small" bulk requests (which could easily fill up the queue), it is usually more efficient to have a single Elasticsearch output.
95
+
In order to minimize the number of open connections to Elasticsearch, maximize
96
+
the bulk size and reduce the number of "small" bulk requests (which could easily
97
+
fill up the queue), it is usually more efficient to have a single Elasticsearch
98
+
output.
95
99
96
100
Example:
97
101
[source,ruby]
@@ -103,8 +107,11 @@ Example:
103
107
104
108
**What to do in case there is no field in the event containing the destination index prefix?**
105
109
106
-
You can use the `mutate` filter and conditionals to add a `[@metadata]` field (see https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata) to set
107
-
the destination index for each event. The `[@metadata]` fields will not be sent to Elasticsearch.
110
+
You can use the `mutate` filter and conditionals to add a `[@metadata]` field
Elasticsearch] to take advantage of response compression when using this plugin.
229
236
230
237
For requests compression, regardless of the Elasticsearch version, enable the
@@ -332,7 +339,7 @@ The Elasticsearch action to perform. Valid actions are:
332
339
- A sprintf style string to change the action based on the content of the event. The value `%{[foo]}`
333
340
would use the foo field for the action
334
341
335
-
For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Elasticsearch bulk API documentation]
342
+
For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html[Elasticsearch bulk API documentation]
336
343
337
344
[id="plugins-{type}s-{plugin}-api_key"]
338
345
===== `api_key`
@@ -342,7 +349,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti
342
349
343
350
Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option.
344
351
345
-
Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key API].
352
+
Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html[Create API key API].
346
353
347
354
[id="plugins-{type}s-{plugin}-bulk_path"]
348
355
===== `bulk_path`
@@ -369,7 +376,7 @@ The .cer or .pem file to validate the server's certificate
369
376
370
377
Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` pair.
371
378
372
-
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
379
+
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]
373
380
374
381
[id="plugins-{type}s-{plugin}-cloud_id"]
375
382
===== `cloud_id`
@@ -379,7 +386,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current
379
386
380
387
Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.
381
388
382
-
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
389
+
For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation]
383
390
384
391
[id="plugins-{type}s-{plugin}-doc_as_upsert"]
385
392
===== `doc_as_upsert`
@@ -430,7 +437,7 @@ If you don't set a value for this option:
430
437
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
431
438
** Otherwise, the default value is `disabled`.
432
439
433
-
Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/current/index.html[Elastic Common Schema (ECS)],
440
+
Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/{branch}/index.html[Elastic Common Schema (ECS)],
434
441
including the installation of ECS-compatible index templates.
435
442
The value of this setting affects the _default_ values of:
436
443
@@ -477,7 +484,7 @@ If you have custom firewall rules you may need to change this
477
484
* Default value is `[//127.0.0.1]`
478
485
479
486
Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter.
480
-
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
487
+
Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[http] address (eg. 9200, not 9300).
481
488
482
489
Examples:
483
490
@@ -487,10 +494,14 @@ Examples:
487
494
`["https://127.0.0.1:9200"]`
488
495
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
489
496
490
-
It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list
491
-
to prevent LS from sending bulk requests to the master nodes. So this parameter should only reference either data or client nodes in Elasticsearch.
0 commit comments