Skip to content

Commit 0862069

Browse files
yaauiekarenzone
andauthored
docs: eliminate confusing and obsolete http compression details (#1000)
* docs: eliminate confusing and obsolete http compression details * patch version bump * Apply suggestions from code review Co-authored-by: Karen Metts <[email protected]> Co-authored-by: Karen Metts <[email protected]>
1 parent 1482fdd commit 0862069

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 11.0.4
2+
- [DOC] Clarify that `http_compression` applies to _requests_, and remove noise about _response_ decompression [#1000](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/1000)
3+
14
## 11.0.3
25
- Fixed SSL handshake hang indefinitely with proxy setup [#1032](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/1032)
36

docs/index.asciidoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -278,16 +278,11 @@ not reevaluate its DNS value while the keepalive is in effect.
278278

279279
==== HTTP Compression
280280

281-
This plugin supports request and response compression. Response compression is
282-
enabled by default for HTTP and for Elasticsearch versions 5.0 and later.
281+
This plugin supports request compression, and handles compressed responses
282+
from Elasticsearch.
283283

284-
You don't have to set any configs in Elasticsearch for it to send back a
285-
compressed response. For versions before 5.0, or if HTTPS is enabled,
286-
`http.compression` must be set to `true` {ref}/modules-http.html#modules-http[in
287-
Elasticsearch] to take advantage of response compression when using this plugin.
288-
289-
For requests compression, regardless of the Elasticsearch version, enable the
290-
`http_compression` setting in the Logstash config file.
284+
To enable request compression, use the <<plugins-{type}s-{plugin}-http_compression>>
285+
setting on this plugin.
291286

292287
==== Authentication
293288

@@ -640,8 +635,13 @@ Any special characters present in the URLs here MUST be URL escaped! This means
640635
* Value type is <<boolean,boolean>>
641636
* Default value is `false`
642637

643-
Enable gzip compression on requests. Note that response compression is on by
644-
default for Elasticsearch v5.0 and beyond
638+
Enable gzip compression on requests.
639+
640+
This setting allows you to reduce this plugin's outbound network traffic by
641+
compressing each bulk _request_ to {es}.
642+
643+
NOTE: This output plugin reads compressed _responses_ from {es} regardless
644+
of the value of this setting.
645645

646646
[id="plugins-{type}s-{plugin}-ilm_enabled"]
647647
===== `ilm_enabled`

logstash-output-elasticsearch.gemspec

Lines changed: 1 addition & 1 deletion
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 = '11.0.3'
3+
s.version = '11.0.4'
44

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

0 commit comments

Comments
 (0)