Skip to content

Commit 612e52e

Browse files
karenzonejsvd
andauthored
[DOC]Remove outdated compatibility notices and rework cloud notice (logstash-plugins#938)
Clarifies role and status of transport protocol Bumps version to v10.5.1 Fixes: logstash-plugins#936 Co-Authored-By: João Duarte <[email protected]>
1 parent d5f1782 commit 612e52e

File tree

3 files changed

+28
-41
lines changed

3 files changed

+28
-41
lines changed

CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 10.5.1
2+
- [DOC] Removed outdated compatibility notices, reworked cloud notice, and fixed formatting for `hosts` examples [#938](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/938)
3+
14
## 10.5.0
25
- Added api_key support [#934](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/934)
36

docs/index.asciidoc

+24-40
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@ include::{include_path}/plugin_header.asciidoc[]
2121

2222
==== Description
2323

24+
If you plan to use the Kibana web interface to analyze data transformed by
25+
Logstash, use the Elasticsearch output plugin to get your data into
26+
Elasticsearch.
27+
28+
This output only speaks the HTTP protocol as it is the preferred protocol for
29+
interacting with Elasticsearch. In previous versions it was possible to
30+
communicate with Elasticsearch through the transport protocol, which is now
31+
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]
34+
to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and
35+
will be removed in 8.0.0
36+
37+
You can learn more about Elasticsearch at <https://www.elastic.co/products/elasticsearch>
38+
2439
.Compatibility Note
2540
[NOTE]
2641
================================================================================
@@ -36,47 +51,12 @@ ensure your template uses the `_doc` document-type before
3651
connecting to Elasticsearch 7.x.
3752
================================================================================
3853

39-
.Compatibility Note
40-
[NOTE]
41-
================================================================================
42-
Starting with Elasticsearch 5.3, there's an {ref}/modules-http.html[HTTP setting]
43-
called `http.content_type.required`. If this option is set to `true`, and you
44-
are using Logstash 2.4 through 5.2, you need to update the Elasticsearch output
45-
plugin to version 6.2.5 or higher.
46-
47-
================================================================================
48-
49-
If you plan to use the Kibana web
50-
interface, use the Elasticsearch output plugin to get your log data into
51-
Elasticsearch.
54+
===== Hosted {es} Service on Elastic Cloud
5255

53-
TIP: You can run Elasticsearch on your own hardware, or use our
56+
You can run Elasticsearch on your own hardware, or use our
5457
https://www.elastic.co/cloud/elasticsearch-service[hosted {es} Service] on
55-
Elastic Cloud. The Elasticsearch Service is available on both AWS and GCP.
56-
{ess-trial}[Try the {es} Service for free].
57-
58-
This output only speaks the HTTP protocol. HTTP is the preferred protocol for interacting with Elasticsearch as of Logstash 2.0.
59-
We strongly encourage the use of HTTP over the node protocol for a number of reasons. HTTP is only marginally slower,
60-
yet far easier to administer and work with. When using the HTTP protocol one may upgrade Elasticsearch versions without having
61-
to upgrade Logstash in lock-step.
62-
63-
You can learn more about Elasticsearch at <https://www.elastic.co/products/elasticsearch>
64-
65-
==== Template management for Elasticsearch 5.x
66-
67-
Index template for this version (Logstash 5.0) has been changed to reflect Elasticsearch's mapping changes in version 5.0.
68-
Most importantly, the subfield for string multi-fields has changed from `.raw` to `.keyword` to match ES default
69-
behavior.
70-
71-
**Users installing ES 5.x and LS 5.x**
72-
73-
This change will not affect you and you will continue to use the ES defaults.
74-
75-
**Users upgrading from LS 2.x to LS 5.x with ES 5.x**
76-
77-
LS will not force upgrade the template, if `logstash` template already exists. This means you will still use
78-
`.raw` for sub-fields coming from 2.x. If you choose to use the new template, you will have to reindex your data after
79-
the new template is installed.
58+
Elastic Cloud. The Elasticsearch Service is available on AWS, Google Cloud
59+
Platform, and Microsoft Azure. {ess-trial}[Try the {es} Service for free].
8060

8161
==== Writing to different indices: best practices
8262

@@ -87,7 +67,7 @@ when using `ilm_rollover_alias`.
8767
8868
================================================================================
8969

90-
If you're sending events to the same Elasticsearch cluster but you're targeting different indices you can:
70+
If you're sending events to the same Elasticsearch cluster, but you're targeting different indices you can:
9171

9272
* use different Elasticsearch outputs, each one with a different value for the `index` parameter
9373
* use one Elasticsearch output and use the dynamic variable substitution for the `index` parameter
@@ -453,11 +433,15 @@ If you have custom firewall rules you may need to change this
453433

454434
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.
455435
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).
436+
437+
Examples:
438+
456439
`"127.0.0.1"`
457440
`["127.0.0.1:9200","127.0.0.2:9200"]`
458441
`["http://127.0.0.1"]`
459442
`["https://127.0.0.1:9200"]`
460443
`["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath)
444+
461445
It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list
462446
to prevent LS from sending bulk requests to the master nodes. So this parameter should only reference either data or client nodes in Elasticsearch.
463447

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.5.0'
3+
s.version = '10.5.1'
44

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

0 commit comments

Comments
 (0)