logstash-input-lumberjack 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d047624d0d97f3184fec85ee0d5a3f9a1fd274
-  data.tar.gz: 82d47b698574bd27368c49237c61e67c4bfcd5f7
+  metadata.gz: 12b4f41cf358aa9dd6e7e398744f74c780371863
+  data.tar.gz: 91ad7e8d873cbfd3f98d310ac9169ac963ca19e2
 SHA512:
-  metadata.gz: a8109970459a4c12f5ee11feb4b0aa12c668da8f840e9ca371e7f448da447993894964bfb1f2310c8766d7e8dd304bf0b30c088a947ecef21745a51d3caf44f9
-  data.tar.gz: 731c6a93b576bc7d221a9aaa66ee965ba12e3be7fe4d1182468195aaa9fb93483d071e136fc004326487af2a03141909981ef17ac2341cc459e82a92aa2b8a27
+  metadata.gz: bd7ec8da4baf22a8c947c9bffcf44aa94db2bfcb3405f59f4ed685b7e34054f30706033f64335f397c92ed8afa0213e62f4606c4f96fe08409a8fdaf3603be3a
+  data.tar.gz: 6b275397ba9b3917f4f12b5f7b4bc6b5b3caea0cc4edd695b443ea00fd8b5a308aab0eb39b5f99ceec46e22a61de841ce8544325927a89f0370333fdf4cc2fe6

data/lib/logstash/circuit_breaker.rb

@@ -4,8 +4,12 @@ require "cabin"
 module LogStash
   # Largely inspired by Martin's fowler circuit breaker
   class CircuitBreaker
+    # Raised when too many errors has occured and we refuse to execute the block
     class OpenBreaker < StandardError; end
 
+    # Raised when we catch an error that we count
+    class HalfOpenBreaker < StandardError; end
+
     # Error threshold before opening the breaker,
     # if the breaker is open it wont execute the code.
     DEFAULT_ERROR_THRESHOLD = 5
@@ -48,6 +52,8 @@ module LogStash
     rescue *@exceptions => e
       logger.warn("CircuitBreaker::rescuing exceptions", :name => @name, :exception => e.class)
       increment_errors(e)
+
+      raise HalfOpenBreaker
     end
 
     def closed?

data/lib/logstash/inputs/lumberjack.rb

@@ -31,10 +31,13 @@ class LogStash::Inputs::Lumberjack < LogStash::Inputs::Base
 
   # This setting no longer has any effect and will be removed in a future release.
   config :max_clients, :validate => :number, :deprecated => "This setting no longer has any effect. See https://github.com/logstash-plugins/logstash-input-lumberjack/pull/12 for the history of this change"
+  
+  # The number of seconds before we raise a timeout,
+  # this option is useful to control how much time to wait if something is blocking the pipeline.
+  config :congestion_threshold, :validate => :number, :default => 5
 
   # TODO(sissel): Add CA to authenticate clients with.
-
-  BUFFERED_QUEUE_SIZE = 20
+  BUFFERED_QUEUE_SIZE = 1
   RECONNECT_BACKOFF_SLEEP = 0.5
   
   def register
@@ -66,52 +69,52 @@ class LogStash::Inputs::Lumberjack < LogStash::Inputs::Base
     start_buffer_broker(output_queue)
 
     while true do
-      begin
-        # Wrapping the accept call into a CircuitBreaker
-        if @circuit_breaker.closed?
-          connection = @lumberjack.accept # Blocking call that creates a new connection
+      # Wrappingu the accept call into a CircuitBreaker
+      if @circuit_breaker.closed?
+        connection = @lumberjack.accept # Blocking call that creates a new connection
 
-          invoke(connection, codec.clone) do |_codec, line, fields|
-            _codec.decode(line) do |event|
+        invoke(connection, @codec.clone) do |_codec, line, fields|
+          _codec.decode(line) do |event|
+            begin
               decorate(event)
               fields.each { |k,v| event[k] = v; v.force_encoding(Encoding::UTF_8) }
-
-              @circuit_breaker.execute { @buffered_queue << event }
+              @circuit_breaker.execute { @buffered_queue.push(event, @congestion_threshold) }
+            rescue => e
+              raise e
             end
           end
-        else
-          @logger.warn("Lumberjack input: the pipeline is blocked, temporary refusing new connection.")
-          sleep(RECONNECT_BACKOFF_SLEEP)
         end
-        # When too many errors happen inside the circuit breaker it will throw 
-        # this exception and start refusing connection, we need to catch it but 
-        # it's safe to ignore.
-      rescue LogStash::CircuitBreaker::OpenBreaker => e
+      else
+        @logger.warn("Lumberjack input: the pipeline is blocked, temporary refusing new connection.")
+        sleep(RECONNECT_BACKOFF_SLEEP)
       end
     end
   rescue LogStash::ShutdownSignal
     @logger.info("Lumberjack input: received ShutdownSignal")
-  rescue => e
-    @logger.error("Lumberjack input: unhandled exception", :exception => e, :backtrace => e.backtrace)
   ensure
     shutdown(output_queue)
   end # def run
 
-  private
-  def accept(&block)
-    connection = @lumberjack.accept # Blocking call that creates a new connection
-    block.call(connection, @codec.clone)
-  end
-
   private
   def invoke(connection, codec, &block)
     @threadpool.post do
       begin
+        # If any errors occur in from the events the connection should be closed in the 
+        # library ensure block and the exception will be handled here
         connection.run do |fields|
           block.call(codec, fields.delete("line"), fields)
         end
-      rescue => e
-        @logger.error("Exception in lumberjack input thread", :exception => e)
+
+        # When too many errors happen inside the circuit breaker it will throw 
+        # this exception and start refusing connection. The bubbling of theses
+        # exceptions make sure that the lumberjack library will close the current 
+        # connection which will force the client to reconnect and restransmit
+        # his payload.
+      rescue LogStash::CircuitBreaker::OpenBreaker,
+        LogStash::CircuitBreaker::HalfOpenBreaker => e
+        logger.warn("Lumberjack input: The circuit breaker has detected a slowdown or stall in the pipeline, the input is closing the current connection and rejecting new connection until the pipeline recover.", :exception => e.class)
+      rescue => e # If we have a malformed packet we should handle that so the input doesn't crash completely.
+        @logger.error("Lumberjack input: unhandled exception", :exception => e, :backtrace => e.backtrace)
       end
     end
   end

data/lib/logstash/sized_queue_timeout.rb

@@ -9,7 +9,7 @@ module LogStash
   class SizedQueueTimeout
     class TimeoutError < StandardError; end
 
-    DEFAULT_TIMEOUT = 2 # in seconds
+    DEFAULT_TIMEOUT = 5 # in seconds
 
     def initialize(max_size, options = {})
       # `concurrent-ruby` are deprecating the `Condition`

data/logstash-input-lumberjack.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-lumberjack'
-  s.version         = '1.0.3'
+  s.version         = '1.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Receive events using the lumberjack protocol."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
 
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'jls-lumberjack', ['>=0.0.23']
+  s.add_runtime_dependency 'jls-lumberjack', ['>=0.0.24']
   s.add_runtime_dependency "concurrent-ruby"
 
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/lumberjack_spec.rb

@@ -7,6 +7,7 @@ require "logstash/codecs/multiline"
 require "logstash/event"
 require "lumberjack/client"
 
+Thread.abort_on_exception = true
 describe LogStash::Inputs::Lumberjack do
   let(:connection) { double("connection") }
   let(:certificate) { LogStashTest.certificate }
@@ -41,7 +42,7 @@ describe LogStash::Inputs::Lumberjack do
       let(:codec) { LogStash::Codecs::Multiline.new("pattern" => '\n', "what" => "previous") }
       it "clone the codec per connection" do
         expect(lumberjack.codec).to receive(:clone).once
-        expect(lumberjack).to receive(:invoke).and_throw(:msg)
+        expect(lumberjack).to receive(:invoke) { break }
         lumberjack.run(queue)
       end
     end

data/spec/logstash/circuit_breaker_spec.rb

@@ -14,33 +14,55 @@ describe LogStash::CircuitBreaker do
 
   subject { LogStash::CircuitBreaker.new("testing", options) }
 
+  context "when the breaker is closed" do
+    it "closed by default" do
+      expect(subject.closed?).to eq(true)
+    end
 
-  it "closed by default" do
-    expect(subject.closed?).to eq(true)
-  end
-
-  context "when having too many errors" do
-    let(:future_time) { Time.now + 3600 }
-    before do
-      subject.execute do
-        raise DummyErrorTest
-      end
+    it "always raise an exception if an errors occur" do
+      expect {
+        subject.execute do
+          raise DummyErrorTest
+        end
+      }.to raise_error(LogStash::CircuitBreaker::HalfOpenBreaker)
     end
 
-    it "raised an exception if we have too many errors" do
+    it "open if we pass the errors threadshold" do
+      expect {
+        subject.execute do
+          raise DummyErrorTest
+        end
+      }.to raise_error(LogStash::CircuitBreaker::HalfOpenBreaker)
+
       expect {
         subject.execute do
           raise DummyErrorTest
         end
       }.to raise_error(LogStash::CircuitBreaker::OpenBreaker)
     end
+  end
+
+  context "When the breaker is open" do
+    let(:future_time) { Time.now + 3600 }
+
+    before do
+      # trip the breaker
+      (error_threshold + 1).times do
+        begin
+          subject.execute do
+            raise DummyErrorTest
+          end
+        rescue
+        end
+      end
+    end
 
-    it "sets the breaker to open" do
+    it "#closed? should return false" do
       expect(subject.closed?).to eq(false)
     end
 
     it "resets the breaker after the time before retry" do
-      expect(Time).to receive(:now).at_least(1).and_return(future_time)
+      expect(Time).to receive(:now).at_least(2).and_return(future_time)
       expect(subject.closed?).to eq(true)
     end
 
@@ -51,7 +73,7 @@ describe LogStash::CircuitBreaker do
         subject.execute do
           runned = true
         end
-      rescue LogStash::CircuitBreaker::OpenBreaker
+      rescue LogStash::CircuitBreaker::OpenBreaker 
       end
 
       expect(runned).to eq(false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -50,12 +50,12 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.23
+        version: 0.0.24
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.23
+        version: 0.0.24
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency