logstash-input-unix 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896c58b0d59a1806706642d094232fd5945bc83b002581c433111fa130e30fe0
-  data.tar.gz: 6c253bcc1a178711308b1f4dbe4ecf2c249ac10f37404347c273e65be5647658
+  metadata.gz: 211693d1622019fadfcdd5f41b94b7e15594abc983aa54000ea59353392b5d4e
+  data.tar.gz: a8b25c6eb9e1627b502b9177f17510d0e631a72c87883058f3d1f2fa93cb145e
 SHA512:
-  metadata.gz: 1bff9d9ceae1b90c4f6a5edaa4557445f46856704b4b5de6629716222ff3758aa9033ddb0efb484954604ce1d4d2cc78ad87210babeb8abe213e347488b7569b
-  data.tar.gz: 269752a4d28c40df2c8bec3e7c8149df818f74f46eae44cf3ce3164f69ddaae7bb894655ec24484656e89021f3cf1af22b4d96257fa9a86428e5cc401ec4c02d
+  metadata.gz: 8c3c0d4cc5bcdee9fb3a32de4593764f9b458861401569ecd16b6055bb905b4d0bf06da68824d0a8358a77e7f4bce2546736a28c407a6a02535150e85364d375
+  data.tar.gz: da09882dac50d95baef03af89fc1b577ddbd31576d28cbdd02dc42fa350284512050480b231dd59ac6da247d8ec84a71c728ab656a29eb1cf443c0b63a440353

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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,25 @@ 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)
+        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
         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 +110,6 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
         @logger.info("Closing connection", :path => @path, :exception => e)
       end
     end
-
   ensure
     begin
       socket.close
@@ -141,9 +136,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.1'
   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.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement