Skip to content

Doc: Update links to logstash-to-cloud docs #975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 10.7.2
- [DOC] Fixed links to restructured Logstash-to-cloud docs [#975](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/975)

## 10.7.1
- [DOC] Document the permissions required in secured clusters [#969](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/969)

Expand Down
30 changes: 19 additions & 11 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,10 @@ Each Elasticsearch output is a new client connected to the cluster:
* it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients)
* it has an associated connection pool

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

Example:
[source,ruby]
Expand All @@ -103,8 +106,11 @@ Example:

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

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
the destination index for each event. The `[@metadata]` fields will not be sent to Elasticsearch.
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 the destination index for each event. The `[@metadata]` fields will not
be sent to Elasticsearch.

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

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

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

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

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

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

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

It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list
to prevent LS from sending bulk requests to the master nodes. So this parameter should only reference either data or client nodes in Elasticsearch.
Exclude
http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated
master nodes] from the `hosts` list to prevent Logstash from sending bulk
requests to the master nodes. This parameter should reference only data or
client nodes in Elasticsearch.

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

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

The number of times Elasticsearch should internally retry an update/upserted document
See the https://www.elastic.co/guide/en/elasticsearch/guide/current/partial-updates.html[partial updates]
for more info
The number of times Elasticsearch should internally retry an update/upserted document.

[id="plugins-{type}s-{plugin}-routing"]
===== `routing`
Expand Down
2 changes: 1 addition & 1 deletion logstash-output-elasticsearch.gemspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = 'logstash-output-elasticsearch'
s.version = '10.7.1'
s.version = '10.7.2'

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