Skip to content

Commit db45b5e

Browse files
authored
Doc: Update links to logstash-to-cloud docs (logstash-plugins#975)
Cloud rework broke some links from the plugins. This work updates the links and points one level up in docs to give user a bit more context for logstash->cloud. Bump to v.10.7.2 Fixes: logstash-plugins#974
1 parent 1e6148c commit db45b5e

File tree

3 files changed

+23
-12
lines changed

3 files changed

+23
-12
lines changed

CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 10.7.2
2+
- [DOC] Fixed links to restructured Logstash-to-cloud docs [#975](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/975)
3+
14
## 10.7.1
25
- [DOC] Document the permissions required in secured clusters [#969](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/969)
36

docs/index.asciidoc

+19-11
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ Each Elasticsearch output is a new client connected to the cluster:
9191
* it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients)
9292
* it has an associated connection pool
9393

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.
94+
In order to minimize the number of open connections to Elasticsearch, maximize
95+
the bulk size and reduce the number of "small" bulk requests (which could easily
96+
fill up the queue), it is usually more efficient to have a single Elasticsearch
97+
output.
9598

9699
Example:
97100
[source,ruby]
@@ -103,8 +106,11 @@ Example:
103106

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

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.
109+
You can use the `mutate` filter and conditionals to add a `[@metadata]` field
110+
(see
111+
https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata)
112+
to set the destination index for each event. The `[@metadata]` fields will not
113+
be sent to Elasticsearch.
108114

109115
Example:
110116
[source,ruby]
@@ -369,7 +375,7 @@ The .cer or .pem file to validate the server's certificate
369375

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

372-
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_auth[Logstash-to-Cloud documentation]
378+
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
373379

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

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

382-
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_id[Logstash-to-Cloud documentation]
388+
For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation]
383389

384390
[id="plugins-{type}s-{plugin}-doc_as_upsert"]
385391
===== `doc_as_upsert`
@@ -487,10 +493,14 @@ Examples:
487493
`["https://127.0.0.1:9200"]`
488494
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
489495

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

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

495505
[id="plugins-{type}s-{plugin}-http_compression"]
496506
===== `http_compression`
@@ -725,9 +735,7 @@ Set max interval in seconds between bulk retries.
725735
* Value type is <<number,number>>
726736
* Default value is `1`
727737

728-
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]
730-
for more info
738+
The number of times Elasticsearch should internally retry an update/upserted document.
731739

732740
[id="plugins-{type}s-{plugin}-routing"]
733741
===== `routing`

logstash-output-elasticsearch.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Gem::Specification.new do |s|
22
s.name = 'logstash-output-elasticsearch'
3-
s.version = '10.7.1'
3+
s.version = '10.7.2'
44

55
s.licenses = ['apache-2.0']
66
s.summary = "Stores logs in Elasticsearch"

0 commit comments

Comments
 (0)