logstash-input-elasticsearch 4.0.4 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3001f304354780e0da016525097045e030d34e32
-  data.tar.gz: fcc39900a7ecb6a858829076430e7a8d1945195e
+  metadata.gz: 3b5f704f5b8a52398cc719f21fc06a86be0169a2
+  data.tar.gz: 495ae9955ec5c1ad60703164271ac568d1b776d3
 SHA512:
-  metadata.gz: 31efd5f40520e84401c016472d49244c009fb21745775022dde902dcd49e9e50acaf76937fe5fbc2c560119ad489b888d0ac5d74cca2d10191ba2104c2647e37
-  data.tar.gz: ec949ec019e0580515a6b7e28e3c7b0c0006e2322b1861a5372a7ee6fabf66f3072fdc0bbe235f52f8002a440b512c478061b14f82095451c743b597e1a5827f
+  metadata.gz: efffda61f2fbcc59ea1d57818c29c35fd5558f1b54b2ce34c0eb98160234b15ff5ad2ebc5cf2428ffd2cd724a67bc0b2ae65e19645ac8d369e526e0026f1f809
+  data.tar.gz: 64e1e4058af406959f555c5c3ddd3f5a37d8952cc2593655c4f1ee88bc74ae074eac6c3a7defc1c161a3e2e92f2be6e9b23d73028645b72a791a240f3bb57dfe

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.0.5
+  - Fix some documentation issues
+
 ## 4.0.3
   - Docs: Add requirement to use version 4.0.2 or higher to support sending Content-Type headers
   - Fix scrolling to use json bodies in the requests (this makes scrolling not work in ES 1.x)

data/docs/index.asciidoc

@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Elasticsearch input plugin
 
@@ -88,7 +88,8 @@ input plugins.
   * Value type is <<path,path>>
   * There is no default value for this setting.
 
-SSL Certificate Authority file in PEM encoded format, must also include any chain certificates as necessary 
+SSL Certificate Authority file in PEM encoded format, must also
+include any chain certificates as necessary.
 
 [id="plugins-{type}s-{plugin}-docinfo"]
 ===== `docinfo` 
@@ -111,7 +112,7 @@ Example
       elasticsearch {
         hosts => "es.production.mysite.org"
         index => "mydata-2018.09.*"
-        query => "*"
+        query => '{ "query": { "query_string": { "query": "*" } } }'
         size => 500
         scroll => "5m"
         docinfo => true
@@ -132,9 +133,11 @@ Example
   * Value type is <<array,array>>
   * Default value is `["_index", "_type", "_id"]`
 
-List of document metadata to move to the `docinfo_target` field
-To learn more about Elasticsearch metadata fields read
-http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_metadata.html
+If document metadata storage is requested by enabling the `docinfo`
+option, this option lists the metadata fields to save in the current
+event. See
+[Document Metadata](http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_metadata.html)
+in the Elasticsearch documentation for more information.
 
 [id="plugins-{type}s-{plugin}-docinfo_target"]
 ===== `docinfo_target` 
@@ -142,7 +145,9 @@ http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_meta
   * Value type is <<string,string>>
   * Default value is `"@metadata"`
 
-Where to move the Elasticsearch document information by default we use the @metadata field.
+If document metadata storage is requested by enabling the `docinfo`
+option, this option names the field under which to store the metadata
+fields as subfields.
 
 [id="plugins-{type}s-{plugin}-hosts"]
 ===== `hosts` 
@@ -150,9 +155,9 @@ Where to move the Elasticsearch document information by default we use the @meta
   * Value type is <<array,array>>
   * There is no default value for this setting.
 
-List of elasticsearch hosts to use for querying.
-each host can be either IP, HOST, IP:port or HOST:port
-port defaults to 9200
+List of one or more Elasticsearch hosts to use for querying. Each host
+can be either IP, HOST, IP:port, or HOST:port. The port defaults to
+9200.
 
 [id="plugins-{type}s-{plugin}-index"]
 ===== `index` 
@@ -168,17 +173,19 @@ The index or alias to search.
   * Value type is <<password,password>>
   * There is no default value for this setting.
 
-Basic Auth - password
+The password to use together with the username in the `user` option
+when authenticating to the Elasticsearch server. If set to an empty
+string authentication will be disabled.
 
 [id="plugins-{type}s-{plugin}-query"]
 ===== `query` 
 
   * Value type is <<string,string>>
-  * Default value is `"{ \"sort\": [ \"_doc\" ] }"`
+  * Default value is `'{ "sort": [ "_doc" ] }'`
 
-The query to be executed. Read the Elasticsearch query DSL documentation
-for more info
-https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+The query to be executed. Read the
+[Elasticsearch query DSL documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)
+for more information.
 
 [id="plugins-{type}s-{plugin}-scroll"]
 ===== `scroll` 
@@ -204,7 +211,8 @@ This allows you to set the maximum number of hits returned per scroll.
   * Value type is <<boolean,boolean>>
   * Default value is `false`
 
-SSL
+If enabled, SSL will be used when communicating with the Elasticsearch
+server (i.e. HTTPS will be used instead of plain HTTP).
 
 [id="plugins-{type}s-{plugin}-user"]
 ===== `user` 
@@ -212,9 +220,11 @@ SSL
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Basic Auth - username
+The username to use together with the password in the `password`
+option when authenticating to the Elasticsearch server. If set to an
+empty string authentication will be disabled.
 
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-elasticsearch.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-elasticsearch'
-  s.version         = '4.0.4'
+  s.version         = '4.0.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read from an Elasticsearch cluster, based on search query results"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.0.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement