logstash-output-elasticsearch 1.0.2-java → 1.0.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 606597e1ab355ae55f2e3a001d8b49d129c56c92
-  data.tar.gz: 93eefd3c03a06af5d37bc32bc5afa3b7636bacb8
+  metadata.gz: 7dfe982500b400c2db41641f7c8e272aae50f445
+  data.tar.gz: b48ebe308211abe1cd74c829db3f2570c3a98024
 SHA512:
-  metadata.gz: 4195eed5510df975b105a7b4d7ae7de0e2be1dd2b5f1a1a14e5ed6587ce5c8ccd20b2b50596d7cb525e9c8446c898859ae6c13646d1e58a960ad34383ef621f1
-  data.tar.gz: 49320ab0592c7a6ca9906cfd3de38cdd8b74bc8620ca90e9fb136d7bf1ff807a4bf65a2c02b9e39825f572540971e6d908607dc8a1f9fce59278136727129d2e
+  metadata.gz: b72b8cd4364ad893b2739dca89836d304bd7a532839271665217ce9efec07bd56ffe34a692cf279586ea9403eef608894084922abd72cf31ad5cfefb2b7f58b7
+  data.tar.gz: b3417490d91c9540c5f6aaf7763fbb4473cf14d89fff4fbfc39d95ee6ed245e2e2ac120475be282d686b73de0334fed54318fd39080c66faef01160460f9b0a1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.0.3
+ - Add HTTP proxy support 
+
 ## 1.0.2
  - Upgrade Manticore HTTP Client
 

data/lib/logstash/outputs/elasticsearch.rb

@@ -309,6 +309,12 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
   # Set max interval between bulk retries
   config :retry_max_interval, :validate => :number, :default => 5
 
+  # Set the address of a forward HTTP proxy. Must be used with the 'http' protocol
+  # Can be either a string, such as 'http://localhost:123' or a hash in the form
+  # {host: 'proxy.org' port: 80 scheme: 'http'}
+  # Note, this is NOT a SOCKS proxy, but a plain HTTP proxy
+  config :proxy
+
   public
   def register
     @submit_mutex = Mutex.new
@@ -372,6 +378,7 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
     end
 
     client_settings.merge! setup_ssl()
+    client_settings.merge! setup_proxy()
 
     common_options = {
       :protocol => @protocol,
@@ -593,6 +600,26 @@ class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
     @logger.debug? and @logger.debug("Switched current elasticsearch client to ##{@client_idx} at #{@host[@client_idx]}")
   end
 
+  private
+  def setup_proxy
+    return {} unless @proxy
+
+    if @protocol != "http"
+      raise(LogStash::ConfigurationError, "Proxy is not supported for '#{@protocol}'. Change the protocol to 'http' if you need HTTP proxy.")
+    end
+
+    # Symbolize keys
+    proxy = if @proxy.is_a?(Hash)
+              Hash[@proxy.map {|k,v| [k.to_sym, v]}]
+            elsif @proxy.is_a?(String)
+              @proxy
+            else
+              raise LogStash::ConfigurationError, "Expected 'proxy' to be a string or hash, not '#{@proxy}''!"
+            end
+
+    return {:proxy => proxy}
+  end
+
   private
   def setup_ssl
     return {} unless @ssl

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

@@ -68,7 +68,8 @@ module LogStash::Outputs::Elasticsearch
           :ssl => options[:client_settings][:ssl],
           :transport_options => {  # manticore settings so we
             :socket_timeout => 0,  # do not timeout socket reads
-            :request_timeout => 0  # and requests
+            :request_timeout => 0,  # and requests
+            :proxy => options[:client_settings][:proxy]
           },
           :transport_class => ::Elasticsearch::Transport::Transport::HTTP::Manticore
         }

data/logstash-output-elasticsearch.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-elasticsearch'
-  s.version         = '1.0.2'
+  s.version         = '1.0.3'
   s.licenses        = ['apache-2.0']
   s.summary         = "Logstash Output to Elasticsearch"
   s.description     = "Output events to elasticsearch"

data/spec/unit/outputs/elasticsearch_proxy_spec.rb

@@ -0,0 +1,59 @@
+require_relative "../../../spec/es_spec_helper"
+require 'stud/temporary'
+require 'elasticsearch'
+require "logstash/outputs/elasticsearch"
+
+describe "Proxy option" do
+  let(:settings) {
+    {
+      "protocol" => "http",
+      "host" => "node01",
+      "proxy" => proxy
+    }
+  }
+  subject {
+    LogStash::Outputs::ElasticSearch.new(settings)
+  }
+
+  before do
+    allow(::Elasticsearch::Client).to receive(:new).with(any_args)
+  end
+
+  describe "valid configs" do
+    before do
+      subject.register
+    end
+
+    context "when specified as a string" do
+      let(:proxy) { "http://127.0.0.1:1234" }
+
+      it "should set the proxy to the exact value" do
+        expect(::Elasticsearch::Client).to have_received(:new) do |options|
+          expect(options[:transport_options][:proxy]).to eql(proxy)
+        end
+      end
+    end
+
+    context "when specified as a hash" do
+      let(:proxy) { {"host" => "127.0.0.1", "protocol" => "http"} }
+
+      it "should pass through the proxy values as symbols" do
+        expected = {:host => proxy["host"], :protocol => proxy["protocol"]}
+        expect(::Elasticsearch::Client).to have_received(:new) do |options|
+          expect(options[:transport_options][:proxy]).to eql(expected)
+        end
+      end
+    end
+  end
+
+  describe "invalid configs" do
+    let(:proxy) { ["bad", "stuff"] }
+
+    it "should have raised an exception" do
+      expect {
+        subject.register
+      }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -196,6 +196,7 @@ files:
 - spec/integration/outputs/templates_spec.rb
 - spec/integration/outputs/transport_create_spec.rb
 - spec/unit/outputs/elasticsearch/protocol_spec.rb
+- spec/unit/outputs/elasticsearch_proxy_spec.rb
 - spec/unit/outputs/elasticsearch_spec.rb
 - spec/unit/outputs/elasticsearch_ssl_spec.rb
 - vendor/jar-dependencies/runtime-jars/antlr-runtime-3.5.jar
@@ -251,5 +252,6 @@ test_files:
 - spec/integration/outputs/templates_spec.rb
 - spec/integration/outputs/transport_create_spec.rb
 - spec/unit/outputs/elasticsearch/protocol_spec.rb
+- spec/unit/outputs/elasticsearch_proxy_spec.rb
 - spec/unit/outputs/elasticsearch_spec.rb
 - spec/unit/outputs/elasticsearch_ssl_spec.rb