logstash-output-elasticsearch 10.3.0-java → 10.3.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ca05594f4d76e1bb341f14088bcafab677339c4322db449c24022d320d22ee
-  data.tar.gz: 79ec3c6d83999b68f9ebfca2c144c5556badfb9046d1f5c968628319623001d4
+  metadata.gz: 0662d42a8fcb66fa69d4c9b348aef3595d9c8297ea5d37391cab2962452ba06a
+  data.tar.gz: 1fbbecbd7b70f22f3c8091402fc4335749b85d5431ead3b6d9ba2a4a5b12b1c7
 SHA512:
-  metadata.gz: '049db8893d70c206be9cfe8e3e93354c98bfbd50d0718b936db79f6e9a07a3927fcdacc352f6e0eec02c0ac22ebd5cc866cd8193efa18a93a9c87f1a40251e7e'
-  data.tar.gz: 6509ec1cc74743832955ed52ecd868546f64712d99f6984285390b41adb71dd09d179d3e180decf9596e587f1b374cf611d0bda33e1e93b8421625d439fd8ae1
+  metadata.gz: 929bf1d422d99ab11ac84c2a63e70de5e211ecdee64036c3c07844cc4b06c61aa22c2e49661c5521db2ee2ce6e8d069d03acfa9a17ff2be196a835a377455074
+  data.tar.gz: f077cb0d83d87b179a226bb9700b837e578adefa2efda988e8aa92225cf531ac2de2c021caeb7f4951e645418bd6646696ba7c54ff9eef9d73720497fd6d1f85

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 10.3.1
+ - Fix: handle proxy => '' as if none was set [#912](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/912)
+
 ## 10.3.0
   - Feat: Added support for cloud_id and cloud_auth [#906](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/906)
 

data/docs/index.asciidoc

@@ -626,6 +626,8 @@ which is bad.
 Set the address of a forward HTTP proxy.
 This used to accept hashes as arguments but now only accepts
 arguments of the URI type to prevent leaking credentials.
+An empty string is treated as if proxy was not set, this is useful when using
+environment variables e.g. `proxy => '${LS_PROXY:}'`.
 
 [id="plugins-{type}s-{plugin}-resurrect_delay"]
 ===== `resurrect_delay` 

data/lib/logstash/outputs/elasticsearch.rb

@@ -188,7 +188,7 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
   # Set the address of a forward HTTP proxy.
   # This used to accept hashes as arguments but now only accepts
   # arguments of the URI type to prevent leaking credentials.
-  config :proxy, :validate => :uri
+  config :proxy, :validate => :uri # but empty string is allowed
 
   # Set the timeout, in seconds, for network operations and requests sent Elasticsearch. If
   # a timeout occurs, the request will be retried.
@@ -238,13 +238,32 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
   # Custom Headers to send on each request to elasticsearch nodes
   config :custom_headers, :validate => :hash, :default => {}
 
+  # @override to handle proxy => '' as if none was set
+  def config_init(params)
+    proxy = params['proxy']
+    if proxy.is_a?(String)
+      # environment variables references aren't yet resolved
+      proxy = deep_replace(proxy)
+      if proxy.empty?
+        params.delete('proxy')
+        @proxy = ''
+      else
+        params['proxy'] = proxy # do not do resolving again
+      end
+    end
+    super(params)
+  end
+
   def build_client
     params["metric"] = metric
+    if @proxy.eql?('')
+      @logger.warn "Supplied proxy setting (proxy => '') has no effect"
+    end
     @client ||= ::LogStash::Outputs::ElasticSearch::HttpClientBuilder.build(@logger, @hosts, params)
   end
 
   def close
-    @stopping.make_true
+    @stopping.make_true if @stopping
     stop_template_installer
     @client.close if @client
   end

data/logstash-output-elasticsearch.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-elasticsearch'
-  s.version         = '10.3.0'
+  s.version         = '10.3.1'
   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_proxy_spec.rb

@@ -69,4 +69,36 @@ describe "Proxy option" do
       end
     end
   end
+
+  context "when specified as ''" do
+    let(:settings) { super.merge("proxy" => "${A_MISSING_ENV_VARIABLE:}")}
+
+    it "should not send the proxy option to manticore" do
+      expect { subject.register }.not_to raise_error
+
+      expect(::Manticore::Client).to have_received(:new) do |options|
+        expect(options).not_to include(:proxy)
+      end
+
+      subject.close
+    end
+  end
+
+  context "when specified as invalid uri" do
+    let(:settings) { super.merge("proxy" => ":")}
+
+    it "should fail" do
+      # SafeURI isn't doing the proper exception wrapping for us, we can not simply :
+      # expect { subject.register }.to raise_error(ArgumentError, /URI is not valid/i)
+      begin
+        subject.register
+      rescue ArgumentError => e
+        expect(e.message).to match /URI is not valid/i
+      rescue java.net.URISyntaxException => e
+        expect(e.message).to match /scheme name/i
+      else
+        fail 'exception not raised'
+      end
+    end
+  end
 end

data/spec/unit/outputs/elasticsearch_spec.rb

@@ -547,7 +547,7 @@ describe LogStash::Outputs::ElasticSearch do
         expect { subject.register }.to raise_error LogStash::ConfigurationError, /cloud_id and hosts/
       end
     end
-  end
+  end if LOGSTASH_VERSION > '6.0'
 
   describe "cloud.auth" do
     let(:do_register) { false }
@@ -580,7 +580,7 @@ describe LogStash::Outputs::ElasticSearch do
         expect { subject.register }.to raise_error LogStash::ConfigurationError, /cloud_auth and user/
       end
     end
-  end
+  end if LOGSTASH_VERSION > '6.0'
 
   context 'handling elasticsearch document-level status meant for the DLQ' do
     let(:options) { { "manage_template" => false } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 10.3.0
+  version: 10.3.1
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement