logstash-input-unix 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 802f228d5171d486df4c13144d64328c687c8f33
-  data.tar.gz: b9b690ed2ec59d91082ced3cce0e6aaac8d612ba
+  metadata.gz: ce52177d18d3c4f2ac356640d08c48919f451689
+  data.tar.gz: b803f47cb17a6d147805ed0ab8070cd8a7ffc61a
 SHA512:
-  metadata.gz: ad2385a3d79601cb05ad859db2ece700c57c4f6e76385de8740851ee3aa1ac3b214ba0561f0b2aca393dd25871afe91f4b8c7aa2af17699c44c9ad4d285f105d
-  data.tar.gz: 89eecc30de4a94594f9b94d82b6cf9b91bf571079b50f76b17f3006823223d4a5ee93fe309cd48b4f5ade95603ea7034ca345f794c5ac9fc9b859a16b96a711f
+  metadata.gz: f6565a89ff69dae14c7459852a8af7302667f24d94f0e1e5192aa62a94efb760357d68741358ab28093855994293ac6d820adf1f9ba4767a84e7b6b7dfe08b5d
+  data.tar.gz: bacb3762def1d9a9f2890e4006fc48893f99f44edd1e3b6a66f5a4e43b1acecb81d8aca2e6bf118c02d0c61df3f290bff73343c58fb4a6bb7e85fb126c5bbaa9

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.3
+  - Preserve values provided in `add_field` for `host` and `path`.
+
 ## 3.0.2
   - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
 

data/lib/logstash/inputs/unix.rb

@@ -32,6 +32,12 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   # `client` connects to a server.
   config :mode, :validate => ["server", "client"], :default => "server"
 
+  # Amount of time in seconds to wait if the socket file is not present, before retrying.
+  # Only positive values are allowed.
+  #
+  # This setting is only used if `mode` is `client`.
+  config :socket_not_present_retry_interval_seconds, :validate => :number, :required => true, :default => 5
+
   def initialize(*args)
     super(*args)
   end # def initialize
@@ -61,6 +67,11 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
                       :path => @path)
         raise
       end
+    else # client
+      if @socket_not_present_retry_interval_seconds < 0
+        @logger.warn("Value #{@socket_not_present_retry_interval_seconds} for socket_not_present_retry_interval_seconds is not valid, using default value of 5 instead")
+        @socket_not_present_retry_interval_seconds = 5
+      end
     end
   end # def register
 
@@ -82,8 +93,8 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
         end
         @codec.decode(buf) do |event|
           decorate(event)
-          event.set("host", hostname)
-          event.set("path", @path)
+          event.set("host", hostname) unless event.include?("host")
+          event.set("path", @path) unless event.include?("path")
           output_queue << event
         end
       end
@@ -119,10 +130,15 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
       end
     else
       while !stop?
-        @client_socket = UNIXSocket.new(@path)
-        @client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
-        @logger.debug("Opened connection", :client => @path)
-        handle_socket(@client_socket, output_queue)
+        if File.socket?(@path) then
+          @client_socket = UNIXSocket.new(@path)
+          @client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
+          @logger.debug("Opened connection", :client => @path)
+          handle_socket(@client_socket, output_queue)
+        else
+          @logger.warn("Socket not present, wait for #{@subscription_retry_interval_seconds} seconds for socket to appear", :client => @path)
+          sleep @socket_not_present_retry_interval_seconds
+        end
       end
     end
   rescue IOError
@@ -135,9 +151,13 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   def stop
     if server?
       File.unlink(@path)
-      @server_socket.close
+      @server_socket.close unless @server_socket.nil?
     else
-      @client_socket.close
+      @client_socket.close unless @client_socket.nil?
     end
+  rescue IOError
+    # if socket with @mode == client was closed by the client, an other call to @client_socket.close
+    # will raise an IOError. We catch IOError here and do nothing, just let logstash terminate
+    @logger.warn("Cloud not close socket while Logstash is shutting down. Socket already closed by the other party?", :path => @path)
   end # def stop
 end # class LogStash::Inputs::Unix

data/logstash-input-unix.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-unix'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read 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

@@ -12,6 +12,19 @@ describe LogStash::Inputs::Unix do
     expect { plugin.register }.to_not raise_error
   end
 
+  describe "when mode is client" do
+
+    let(:mode) { "client" }
+
+    context "if socket_not_present_retry_interval_seconds is out of bounds" do
+      it "should fallback to default value" do
+        plugin = LogStash::Plugin.lookup("input", "unix").new({ "path" => tempfile.path, "force_unlink" => true, "mode" => mode, "socket_not_present_retry_interval_seconds" => -1 })
+        plugin.register
+        expect(plugin.instance_variable_get(:@socket_not_present_retry_interval_seconds)).to be 5
+      end
+    end
+  end
+
   describe "when interrupting the plugin" do
 
     context "#server" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-unix
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Read events over a UNIX socket.