logstash-output-elasticsearch 9.1.4-java → 9.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8917f99f05252cd3a9386839e0dbdbcc5196660620a60f15b3505979f76dcde
-  data.tar.gz: f0eff97eb0951baa55a73db99131784ee9ddfd6498eab5b6d0bbf616582e728c
+  metadata.gz: 6d35b36dcfe8e22093ba7168cfe5dd86b40aefd706a31dc0264c7c65cec5003e
+  data.tar.gz: 64e0591505d8ea28dc0b739d6b7c0408384aaedbd8dade246ca21d59c3ad3e05
 SHA512:
-  metadata.gz: 1832b2292c90c7c63ac4390a615abbd4215351f5949ec33d1e9a51e450af9066a09294cdb89b9bb24a9eed77d9546860eb929c80d6c515acb507b7c6bbab4397
-  data.tar.gz: 6bee0365e4003c390e098901ae6ec0f62dec19123b7cdef184bed92eecb9c1d54cf5bfc0130a202f0f8cae72c5ae1fbb3eb89cfdd7731ebba0da7afc816eff50
+  metadata.gz: 96fcb5f6f82c621eff1db8675f510c66550d7fd43b53edbccf0d030081907a13dde42fa2086c0dffc8bea64d210bc6220c696ab02e0319977a441704bd10d920
+  data.tar.gz: d6878897f12cc383206a2412c730f9aee19bd70f090637d32a09ba086db3cf5d8a1132590041de75fd815d6cfd96133c1303feca3ec300e5a9757236bfbae2de

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 9.2.0
+  - Added support for customizing HTTP headers [#782](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/782)
+
 ## 9.1.4
   - Log an error -- not a warning -- when ES raises an invalid\_index\_name\_exception.
 

data/docs/index.asciidoc

@@ -124,6 +124,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-action>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-bulk_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-custom_headers>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-doc_as_upsert>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-document_id>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-document_type>> |<<string,string>>|No
@@ -258,6 +259,17 @@ Set the Elasticsearch errors in the whitelist that you don't want to log.
 A useful example is when you want to skip all 409 errors
 which are `document_already_exists_exception`.
 
+[id="plugins-{type}s-{plugin}-custom_headers"]
+===== `custom_headers`
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+Pass a set of key value pairs as the headers sent in each request to
+an elasticsearch node. The headers will be used for any kind of request
+(_bulk request, template installation, health checks and sniffing).
+These custom headers will be overidden by settings like `http_compression`.
+
 [id="plugins-{type}s-{plugin}-healthcheck_path"]
 ===== `healthcheck_path` 
 

data/lib/logstash/outputs/elasticsearch.rb

@@ -226,6 +226,9 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
   # Enable gzip compression on requests. Note that response compression is on by default for Elasticsearch v5.0 and beyond
   config :http_compression, :validate => :boolean, :default => false
 
+  # Custom Headers to send on each request to elasticsearch nodes
+  config :custom_headers, :validate => :hash, :default => {}
+
   def build_client
     params["metric"] = metric
     @client ||= ::LogStash::Outputs::ElasticSearch::HttpClientBuilder.build(@logger, @hosts, params)

data/lib/logstash/outputs/elasticsearch/http_client.rb

@@ -46,6 +46,7 @@ module LogStash; module Outputs; class ElasticSearch;
     # * `:ssl` - Boolean. Enable or disable SSL/TLS.
     # * `:proxy` - String. Choose a HTTP HTTProxy to use.
     # * `:path` - String. The leading path for prefixing Elasticsearch
+    # * `:headers` - Hash. Pairs of headers and their values
     #   requests. This is sometimes used if you are proxying Elasticsearch access
     #   through a special http path, such as using mod_rewrite.
     def initialize(options={})
@@ -53,11 +54,11 @@ module LogStash; module Outputs; class ElasticSearch;
       @metric = options[:metric]
       @bulk_request_metrics = @metric.namespace(:bulk_requests)
       @bulk_response_metrics = @bulk_request_metrics.namespace(:responses)
-      
+
       # Again, in case we use DEFAULT_OPTIONS in the future, uncomment this.
       # @options = DEFAULT_OPTIONS.merge(options)
       @options = options
-      
+
       @url_template = build_url_template
 
       @pool = build_pool(@options)
@@ -65,7 +66,7 @@ module LogStash; module Outputs; class ElasticSearch;
       # connection pool at the same time
       @bulk_path = @options[:bulk_path]
     end
-    
+
     def build_url_template
       {
         :scheme => self.scheme,
@@ -138,7 +139,7 @@ module LogStash; module Outputs; class ElasticSearch;
 
     def bulk_send(body_stream)
       params = http_compression ? {:headers => {"Content-Encoding" => "gzip"}} : {}
-      # Discard the URL 
+      # Discard the URL
       response = @pool.post(@bulk_path, params, body_stream.string)
       if !body_stream.closed?
         body_stream.truncate(0)
@@ -274,7 +275,9 @@ module LogStash; module Outputs; class ElasticSearch;
       end
 
       adapter_options[:ssl] = ssl_options if self.scheme == 'https'
-      
+
+      adapter_options[:headers] = client_settings[:headers] if client_settings[:headers]
+
       adapter_class = ::LogStash::Outputs::ElasticSearch::HttpClient::ManticoreAdapter
       adapter = adapter_class.new(@logger, adapter_options)
     end

data/lib/logstash/outputs/elasticsearch/http_client_builder.rb

@@ -7,7 +7,8 @@ module LogStash; module Outputs; class ElasticSearch;
         :pool_max => params["pool_max"],
         :pool_max_per_route => params["pool_max_per_route"],
         :check_connection_timeout => params["validate_after_inactivity"],
-        :http_compression => params["http_compression"]
+        :http_compression => params["http_compression"],
+        :headers => params["custom_headers"]
       }
       
       client_settings[:proxy] = params["proxy"] if params["proxy"]

data/logstash-output-elasticsearch.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-elasticsearch'
-  s.version         = '9.1.4'
+  s.version         = '9.2.0'
   s.licenses        = ['apache-2.0']
   s.summary         = "Stores logs in Elasticsearch"
   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"

data/spec/unit/outputs/elasticsearch_spec.rb

@@ -555,4 +555,22 @@ describe LogStash::Outputs::ElasticSearch do
       end
     end
   end
+
+  describe "custom headers" do
+    let(:manticore_options) { subject.client.pool.adapter.manticore.instance_variable_get(:@options) } 
+
+    context "when set" do
+      let(:headers) { { "X-Thing" => "Test" } }
+      let(:options) { { "custom_headers" => headers } }
+      it "should use the custom headers in the adapter options" do
+        expect(manticore_options[:headers]).to eq(headers)
+      end
+    end
+
+    context "when not set" do
+      it "should have no headers" do
+        expect(manticore_options[:headers]).to be_empty
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 9.1.4
+  version: 9.2.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement