logstash-input-unix 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 211693d1622019fadfcdd5f41b94b7e15594abc983aa54000ea59353392b5d4e
-  data.tar.gz: a8b25c6eb9e1627b502b9177f17510d0e631a72c87883058f3d1f2fa93cb145e
+  metadata.gz: dce11755b6f6a09ad708f79ee8d9e85fb87e0d98bf2aaedb6d47a316e1de6731
+  data.tar.gz: 84c73daebb51aa1813b528e42113e1a26f73a5162ced25a8c9043648daf54f14
 SHA512:
-  metadata.gz: 8c3c0d4cc5bcdee9fb3a32de4593764f9b458861401569ecd16b6055bb905b4d0bf06da68824d0a8358a77e7f4bce2546736a28c407a6a02535150e85364d375
-  data.tar.gz: da09882dac50d95baef03af89fc1b577ddbd31576d28cbdd02dc42fa350284512050480b231dd59ac6da247d8ec84a71c728ab656a29eb1cf443c0b63a440353
+  metadata.gz: a259754acac7b218a5f62f6341f981266833a26395f3fd4341fcec6ed1af843d891561937cd7a16a2478863d2bd7a5d61b85dfe62a00b4ee3f340b35f3ce02d6
+  data.tar.gz: f85ae87765a0c9ddde40a91d8b4438d4e62d6ec68b1abb187d6c59fa3e643f4ce624656f97a13fd84fde86e85c63021e46f8eafddef1ba05ea8a9557a312b2ca

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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

data/lib/logstash/inputs/unix.rb

@@ -84,16 +84,15 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
     begin
       hostname = Socket.gethostname
       while !stop?
-        data = socket.read_nonblock(16384, exception: false)
-
-        if data == :wait_readable
-          if @data_timeout == -1 || IO.select([socket], nil, nil, @data_timeout)
-            next # retry socket read
-          else
-            # socket not ready after @data_timeout seconds
-            @logger.info("Closing connection after read timeout", :path => @path)
-            return
-          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(data) do |event|
@@ -118,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"

data/logstash-input-unix.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-unix'
-  s.version         = '3.1.1'
+  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"

metadata

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