Skip to content

Commit 4109cfd

Browse files
committed
Add and set branch attribute
1 parent 91485d6 commit 4109cfd

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

docs/index.asciidoc

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:plugin: elasticsearch
22
:type: output
33
:no_codec:
4+
:branch: current
45

56
///////////////////////////////////////////
67
START - GENERATED VARIABLES, DO NOT EDIT!
@@ -29,8 +30,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for
2930
interacting with Elasticsearch. In previous versions it was possible to
3031
communicate with Elasticsearch through the transport protocol, which is now
3132
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]
3435
to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and
3536
will be removed in 8.0.0
3637

@@ -91,7 +92,10 @@ Each Elasticsearch output is a new client connected to the cluster:
9192
* it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients)
9293
* it has an associated connection pool
9394

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.
9599

96100
Example:
97101
[source,ruby]
@@ -103,8 +107,11 @@ Example:
103107

104108
**What to do in case there is no field in the event containing the destination index prefix?**
105109

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
111+
(see
112+
https://www.elastic.co/guide/en/logstash/{branch}/event-dependent-configuration.html#metadata)
113+
to set the destination index for each event. The `[@metadata]` fields will not
114+
be sent to Elasticsearch.
108115

109116
Example:
110117
[source,ruby]
@@ -224,7 +231,7 @@ enabled by default for HTTP and for Elasticsearch versions 5.0 and later.
224231
You don't have to set any configs in Elasticsearch for it to send back a
225232
compressed response. For versions before 5.0, or if HTTPS is enabled,
226233
`http.compression` must be set to `true`
227-
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[in
234+
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[in
228235
Elasticsearch] to take advantage of response compression when using this plugin.
229236

230237
For requests compression, regardless of the Elasticsearch version, enable the
@@ -332,7 +339,7 @@ The Elasticsearch action to perform. Valid actions are:
332339
- A sprintf style string to change the action based on the content of the event. The value `%{[foo]}`
333340
would use the foo field for the action
334341

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]
336343

337344
[id="plugins-{type}s-{plugin}-api_key"]
338345
===== `api_key`
@@ -342,7 +349,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti
342349

343350
Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option.
344351

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].
346353

347354
[id="plugins-{type}s-{plugin}-bulk_path"]
348355
===== `bulk_path`
@@ -369,7 +376,7 @@ The .cer or .pem file to validate the server's certificate
369376

370377
Cloud authentication string ("<username>:<password>" format) is an alternative for the `user`/`password` pair.
371378

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]
373380

374381
[id="plugins-{type}s-{plugin}-cloud_id"]
375382
===== `cloud_id`
@@ -379,7 +386,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current
379386

380387
Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used.
381388

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]
383390

384391
[id="plugins-{type}s-{plugin}-doc_as_upsert"]
385392
===== `doc_as_upsert`
@@ -430,7 +437,7 @@ If you don't set a value for this option:
430437
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
431438
** Otherwise, the default value is `disabled`.
432439

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)],
434441
including the installation of ECS-compatible index templates.
435442
The value of this setting affects the _default_ values of:
436443

@@ -477,7 +484,7 @@ If you have custom firewall rules you may need to change this
477484
* Default value is `[//127.0.0.1]`
478485

479486
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).
481488

482489
Examples:
483490

@@ -487,10 +494,14 @@ Examples:
487494
`["https://127.0.0.1:9200"]`
488495
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
489496

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.
497+
Exclude
498+
http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html[dedicated
499+
master nodes] from the `hosts` list to prevent Logstash from sending bulk
500+
requests to the master nodes. This parameter should reference only data or
501+
client nodes in Elasticsearch.
492502

493-
Any special characters present in the URLs here MUST be URL escaped! This means `#` should be put in as `%23` for instance.
503+
Any special characters present in the URLs here MUST be URL escaped! This means
504+
`#` should be put in as `%23` for instance.
494505

495506
[id="plugins-{type}s-{plugin}-http_compression"]
496507
===== `http_compression`
@@ -726,7 +737,7 @@ Set max interval in seconds between bulk retries.
726737
* Default value is `1`
727738

728739
The number of times Elasticsearch should internally retry an update/upserted document
729-
See the https://www.elastic.co/guide/en/elasticsearch/guide/current/partial-updates.html[partial updates]
740+
See the https://www.elastic.co/guide/en/elasticsearch/guide/{branch}/partial-updates.html[partial updates]
730741
for more info
731742

732743
[id="plugins-{type}s-{plugin}-routing"]
@@ -958,11 +969,12 @@ See https://www.elastic.co/blog/elasticsearch-versioning-support.
958969

959970
The version_type to use for indexing.
960971
See https://www.elastic.co/blog/elasticsearch-versioning-support.
961-
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_version_types
972+
See also https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html#_version_types
962973

963974

964975

965976
[id="plugins-{type}s-{plugin}-common-options"]
966977
include::{include_path}/{type}.asciidoc[]
967978

979+
:branch!:
968980
:no_codec!:

0 commit comments

Comments
 (0)