logstash-input-unix 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896c58b0d59a1806706642d094232fd5945bc83b002581c433111fa130e30fe0
-  data.tar.gz: 6c253bcc1a178711308b1f4dbe4ecf2c249ac10f37404347c273e65be5647658
+  metadata.gz: dce11755b6f6a09ad708f79ee8d9e85fb87e0d98bf2aaedb6d47a316e1de6731
+  data.tar.gz: 84c73daebb51aa1813b528e42113e1a26f73a5162ced25a8c9043648daf54f14
 SHA512:
-  metadata.gz: 1bff9d9ceae1b90c4f6a5edaa4557445f46856704b4b5de6629716222ff3758aa9033ddb0efb484954604ce1d4d2cc78ad87210babeb8abe213e347488b7569b
-  data.tar.gz: 269752a4d28c40df2c8bec3e7c8149df818f74f46eae44cf3ce3164f69ddaae7bb894655ec24484656e89021f3cf1af22b4d96257fa9a86428e5cc401ec4c02d
+  metadata.gz: a259754acac7b218a5f62f6341f981266833a26395f3fd4341fcec6ed1af843d891561937cd7a16a2478863d2bd7a5d61b85dfe62a00b4ee3f340b35f3ce02d6
+  data.tar.gz: f85ae87765a0c9ddde40a91d8b4438d4e62d6ec68b1abb187d6c59fa3e643f4ce624656f97a13fd84fde86e85c63021e46f8eafddef1ba05ea8a9557a312b2ca

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.1.2
+  - Fix: eliminate high CPU usage when data timeout is disabled and no data is available on the socket [#30](https://github.com/logstash-plugins/logstash-input-unix/pull/30)
+
+## 3.1.1
+  - Fix: unable to stop plugin (on LS 6.x) [#29](https://github.com/logstash-plugins/logstash-input-unix/pull/29)
+  - Refactor: plugin internals got reviewed for `data_timeout => ...` to work reliably
+
 ## 3.1.0
   - Feat: adjust fields for ECS compatibility [#28](https://github.com/logstash-plugins/logstash-input-unix/pull/28) 
 

data/lib/logstash/inputs/unix.rb

@@ -15,8 +15,6 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
 
   include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
 
-  class Interrupted < StandardError; end
-
   config_name "unix"
 
   default :codec, "line"
@@ -54,7 +52,6 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   public
   def register
     require "socket"
-    require "timeout"
 
     if server?
       @logger.info("Starting unix input listener", :address => @path, :force_unlink => @force_unlink)
@@ -87,26 +84,24 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
     begin
       hostname = Socket.gethostname
       while !stop?
-        buf = nil
-        # NOTE(petef): the timeout only hits after the line is read
-        # or socket dies
-        # TODO(sissel): Why do we have a timeout here? What's the point?
-        if @data_timeout == -1
-          buf = socket.readpartial(16384)
-        else
-          Timeout::timeout(@data_timeout) do
-            buf = socket.readpartial(16384)
-          end
+        data = io_interruptable_readpartial(socket, 16384, @data_timeout)
+
+        if data == :data_timeout
+          # socket not ready after @data_timeout seconds
+          @logger.info("Closing connection after read timeout", :path => @path)
+          return
+        elsif data == :stopping
+          @logger.trace("Shutdown in progress", :path => @path)
+          next # let next loop handle graceful stop
         end
-        @codec.decode(buf) do |event|
+
+        @codec.decode(data) do |event|
           decorate(event)
           event.set(@host_name_field, hostname) unless event.include?(@host_name_field)
           event.set(@file_path_field, @path) unless event.include?(@file_path_field)
           output_queue << event
         end
       end
-    rescue Timeout::Error
-      @logger.info("Closing connection after read timeout", :path => @path)
     rescue => e
       if @logger.debug?
         @logger.debug("Closing connection", :path => @path, :exception => e, :backtrace => e.backtrace)
@@ -114,7 +109,6 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
         @logger.info("Closing connection", :path => @path, :exception => e)
       end
     end
-
   ensure
     begin
       socket.close
@@ -123,6 +117,35 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
     end
   end
 
+  ##
+  # Emulates `IO#readpartial` with a timeout and our plugin's stop-condition,
+  # limiting blocking calls to windows of 10s or less to ensure it can be interrupted.
+  #
+  # @param readable_io [IO] the IO to read from
+  # @param maxlen [Integer] the max bytes to be read
+  # @param timeout [Number] the maximum number of seconds to , or -1 to disable timeouts
+  #
+  # @return [:data_timeout] if timeout was reached before bytes were available
+  # @return [:stopping] if plugin stop-condition was detected before bytes were available
+  # @return [String] a non-empty string if bytes became available before the timeout was reached
+  def io_interruptable_readpartial(readable_io, maxlen, timeout)
+
+    data_timeout_deadline = timeout < 0 ? nil : Time.now + timeout
+    maximum_blocking_seconds = timeout < 0 || timeout > 10 ? 10 : timeout
+
+    loop do
+      return :stopping if stop?
+      result = readable_io.read_nonblock(maxlen, exception: false)
+
+      return result if result.kind_of?(String)
+      raise EOFError if result.nil?
+
+      return :data_timeout if (data_timeout_deadline && data_timeout_deadline < Time.now)
+      IO.select([readable_io], nil, nil, maximum_blocking_seconds)
+    end
+  end
+  private :io_interruptable_readpartial
+
   private
   def server?
     @mode == "server"
@@ -141,9 +164,9 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
       end
     else
       while !stop?
-        if File.socket?(@path) then
+        if File.socket?(@path)
           @client_socket = UNIXSocket.new(@path)
-          @client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
+          @client_socket.extend ::LogStash::Util::SocketPeer
           @logger.debug("Opened connection", :client => @path)
           handle_socket(@client_socket, output_queue)
         else

data/logstash-input-unix.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-unix'
-  s.version         = '3.1.0'
+  s.version         = '3.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events over a UNIX socket"
   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/inputs/unix_spec.rb

@@ -55,8 +55,29 @@ describe LogStash::Inputs::Unix do
     end
 
     context "when the unix socket has no data to be read" do
-      it_behaves_like "an interruptible input plugin" do
-        let(:run_forever) { false }
+
+      let(:run_forever) { false }
+
+      it_behaves_like "an interruptible input plugin"
+
+      context 'with timeout' do
+
+        let(:config) { super().merge "data_timeout" => 1.0 }
+
+        let(:queue) { SizedQueue.new(10) }
+        before(:each) { subject.register }
+        after(:each) { subject.do_stop }
+
+        it "closes socket after timeout" do
+          plugin_thread = Thread.new(subject, queue) { |subject, queue| subject.run(queue) }
+          sleep 0.5
+          client_socket = subject.instance_variable_get :@client_socket
+          expect( client_socket.closed? ).to be false
+          sleep 1.0 # allow timeout to kick in
+          expect( client_socket.closed? ).to be true
+          expect( plugin_thread ).to be_alive
+        end
+
       end
     end
 

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ class UnixSocketHelper
   end
 
   def new_socket(path)
-    @path   = path
+    @path = path
     File.unlink if File.exists?(path) && File.socket?(path)
     @socket = UNIXServer.new(path)
     self
@@ -31,7 +31,6 @@ class UnixSocketHelper
   end
 
   def close
-    @thread.kill
     @socket.close
     File.unlink(path)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-unix
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement