logstash-input-unix 3.0.7 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ff2458154a2198a7fef192ccd0ca96c888ab35abc23070137a27bf6132af41
-  data.tar.gz: c6fab6c83f7d019f73924b876db9c4f29113384ff52c96c6fe3b3207ee5a9c75
+  metadata.gz: 896c58b0d59a1806706642d094232fd5945bc83b002581c433111fa130e30fe0
+  data.tar.gz: 6c253bcc1a178711308b1f4dbe4ecf2c249ac10f37404347c273e65be5647658
 SHA512:
-  metadata.gz: e82f2a34c267b1af083774e5fdf129ac8e80f061a475f3852d1e18c82a193c36b5ab5c5dbba210b70f1b2e6146d8f9d02a5fb0c1653a4b3d9a58934858520ed4
-  data.tar.gz: bcdd55ee57f9cd82af6ab8a22d1acdf3e4c512720ddafe118a28029943151f26d0a37165db5e4a084841d5c30b64c9bd04ec76aabb13f5275d88d38b83828983
+  metadata.gz: 1bff9d9ceae1b90c4f6a5edaa4557445f46856704b4b5de6629716222ff3758aa9033ddb0efb484954604ce1d4d2cc78ad87210babeb8abe213e347488b7569b
+  data.tar.gz: 269752a4d28c40df2c8bec3e7c8149df818f74f46eae44cf3ce3164f69ddaae7bb894655ec24484656e89021f3cf1af22b4d96257fa9a86428e5cc401ec4c02d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+  - Feat: adjust fields for ECS compatibility [#28](https://github.com/logstash-plugins/logstash-input-unix/pull/28) 
+
 ## 3.0.7
   - Docs: Set the default_codec doc attribute.
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-unix.svg)](https://travis-ci.org/logstash-plugins/logstash-input-unix)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-unix.svg)](https://travis-ci.com/logstash-plugins/logstash-input-unix)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -28,6 +28,23 @@ Like `stdin` and `file` inputs, each event is assumed to be one line of text.
 Can either accept connections from clients or connect to a server,
 depending on `mode`.
 
+[id="plugins-{type}s-{plugin}-ecs"]
+==== Compatibility with the Elastic Common Schema (ECS)
+
+This plugin adds extra fields about the event's source. 
+Configure the <<plugins-{type}s-{plugin}-ecs_compatibility>> option if you want
+to ensure that these fields are compatible with {ecs-ref}[ECS].
+
+These fields are added after the event has been decoded by the appropriate codec,
+and will not overwrite existing values.
+
+|========
+| ECS Disabled | ECS v1 , v8      | Description
+
+| `host`       | `[host][name]`   | The name of the {ls} host that processed the event
+| `path`       | `[file][path]`   | The socket path configured in the plugin
+|========
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== Unix Input Configuration Options
 
@@ -37,6 +54,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-data_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-force_unlink>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["server", "client"]`|No
 | <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
@@ -59,6 +77,44 @@ more than this timeout period, we will assume it is dead and close it.
 
 If you never want to timeout, use -1.
 
+[id="plugins-{type}s-{plugin}-ecs_compatibility"]
+===== `ecs_compatibility`
+
+  * Value type is <<string,string>>
+  * Supported values are:
+    ** `disabled`: uses backwards compatible field names, such as `[host]`
+    ** `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
+
+Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
+See <<plugins-{type}s-{plugin}-ecs>> for detailed information.
+
+
+**Sample output: ECS enabled**
+[source,ruby]
+-----
+{
+    "@timestamp" => 2021-11-16T13:20:06.308Z,
+    "file" => {
+      "path" => "/tmp/sock41299"
+    },
+    "host" => {
+      "name" => "deus-ex-machina"
+    },
+    "message" => "foo"
+}
+-----
+
+**Sample output: ECS disabled**
+[source,ruby]
+-----
+{
+    "@timestamp" => 2021-11-16T13:20:06.308Z,
+    "path" => "/tmp/sock41299",
+    "host" => "deus-ex-machina",
+    "message" => "foo"
+}
+-----
+
 [id="plugins-{type}s-{plugin}-force_unlink"]
 ===== `force_unlink` 
 

data/lib/logstash/inputs/unix.rb

@@ -3,6 +3,8 @@ require "logstash/inputs/base"
 require "logstash/namespace"
 require "logstash/util/socket_peer"
 
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+
 # Read events over a UNIX socket.
 #
 # Like `stdin` and `file` inputs, each event is assumed to be one line of text.
@@ -10,7 +12,11 @@ require "logstash/util/socket_peer"
 # Can either accept connections from clients or connect to a server,
 # depending on `mode`.
 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"
@@ -38,8 +44,11 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   # 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)
+  def initialize(*params)
+    super
+
+    @host_name_field = ecs_select[disabled: 'host', v1: '[host][name]']
+    @file_path_field = ecs_select[disabled: 'path', v1: '[file][path]']
   end # def initialize
 
   public
@@ -48,7 +57,7 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
     require "timeout"
 
     if server?
-      @logger.info("Starting unix input listener", :address => "#{@path}", :force_unlink => "#{@force_unlink}")
+      @logger.info("Starting unix input listener", :address => @path, :force_unlink => @force_unlink)
       begin
         @server_socket = UNIXServer.new(@path)
       rescue Errno::EADDRINUSE, IOError
@@ -58,18 +67,16 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
             @server_socket = UNIXServer.new(@path)
             return
           rescue Errno::EADDRINUSE, IOError
-            @logger.error("!!!Could not start UNIX server: Address in use",
-                          :path => @path)
+            @logger.error("Could not start UNIX server: address in use", :path => @path)
             raise
           end
         end
-        @logger.error("Could not start UNIX server: Address in use",
-                      :path => @path)
+        @logger.error("Could not start UNIX server: address in use", :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")
+      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
@@ -93,16 +100,20 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
         end
         @codec.decode(buf) do |event|
           decorate(event)
-          event.set("host", hostname) unless event.include?("host")
-          event.set("path", @path) unless event.include?("path")
+          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 => e
-      @logger.debug("Closing connection", :path => @path, :exception => e, :backtrace => e.backtrace)
     rescue Timeout::Error
-      @logger.debug("Closing connection after read timeout", :path => @path)
-    end # begin
+      @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)
+      else
+        @logger.info("Closing connection", :path => @path, :exception => e)
+      end
+    end
 
   ensure
     begin
@@ -124,7 +135,7 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
       while !stop?
         # Start a new thread for each connection.
         @client_threads << Thread.start(@server_socket.accept) do |s|
-          @logger.debug("Accepted connection", :server => "#{@path}")
+          @logger.debug("Accepted connection", :server => @path)
           handle_socket(s, output_queue)
         end
       end
@@ -136,8 +147,8 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
           @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
+          @logger.warn("Socket not present, wait for #{socket_not_present_retry_interval_seconds} seconds for socket to appear", :client => @path)
+          sleep socket_not_present_retry_interval_seconds
         end
       end
     end
@@ -158,6 +169,6 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   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)
+    @logger.warn("Could 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.7'
+  s.version         = '3.1.0'
   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"
@@ -21,8 +21,9 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
   s.add_runtime_dependency 'logstash-codec-line'
+
   s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/inputs/unix_spec.rb

@@ -1,64 +1,95 @@
 # encoding: utf-8
 require_relative "../spec_helper"
+require "logstash/devutils/rspec/shared_examples"
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
 require "stud/temporary"
 require "tempfile"
 
 describe LogStash::Inputs::Unix do
 
-  let(:tempfile)   { Tempfile.new("/tmp/foo") }
+  let(:config) { { 'path' => tempfile.path, 'socket_not_present_retry_interval_seconds' => 1, 'force_unlink' => true } }
+  let(:tempfile) { Tempfile.new("unix-input-test") }
+
+  subject(:input) { described_class.new(config) }
 
   it "should register without errors" do
-    plugin = LogStash::Plugin.lookup("input", "unix").new({ "path" => tempfile.path, "force_unlink" => true })
-    expect { plugin.register }.to_not raise_error
+    expect { subject.register }.to_not raise_error
   end
 
   describe "when mode is client" do
 
-    let(:mode) { "client" }
+    let(:config) { super().merge("mode" => 'client', "socket_not_present_retry_interval_seconds" => -1) }
 
     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
+        subject.register
+        expect( subject.socket_not_present_retry_interval_seconds ).to eql 5
       end
     end
   end
 
-  describe "when interrupting the plugin" do
+  context "#server" do
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { super().merge "mode" => 'server' }
+    end
+  end
 
-    context "#server" do
-      it_behaves_like "an interruptible input plugin" do
-        let(:config) { { "path" => tempfile.path, "force_unlink" => true } }
-      end
+  context "#client", :ecs_compatibility_support do
+    let(:temp_path)    { "/tmp/sock#{rand(65532)}" }
+    let(:config)      { super().merge "path" => temp_path, "mode" => "client" }
+    let(:unix_socket) { UnixSocketHelper.new('foo').new_socket(temp_path) }
+    let(:run_forever) { true }
+
+    before(:each) do
+      unix_socket.loop(run_forever)
     end
 
-    context "#client" do
-      let(:tempfile)    { "/tmp/sock#{rand(65532)}" }
-      let(:config)      { { "path" => tempfile, "mode" => "client" } }
-      let(:unix_socket) { UnixSocketHelper.new.new_socket(tempfile) }
-      let(:run_forever) { true }
+    after(:each) do
+      unix_socket.close
+    end
 
-      before(:each) do
-        unix_socket.loop(run_forever)
+    context "when the unix socket has data to be read" do
+      it_behaves_like "an interruptible input plugin" do
+        let(:run_forever) { true }
       end
+    end
 
-      after(:each) do
-        unix_socket.close
+    context "when the unix socket has no data to be read" do
+      it_behaves_like "an interruptible input plugin" do
+        let(:run_forever) { false }
       end
+    end
+
+    ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+      let(:config) { super().merge 'ecs_compatibility' => ecs_compatibility }
 
-      context "when the unix socket has data to be read" do
-        it_behaves_like "an interruptible input plugin" do
-          let(:run_forever) { true }
+      let(:queue) { java.util.Vector.new }
+
+      it 'generates events with host, path and message set' do
+        subject.register
+        Thread.new(subject, queue) { |subject, queue| subject.run(queue) }
+        try(10) do
+          expect( queue.size ).to_not eql 0
         end
-      end
+        subject.do_stop # stop the plugin
 
-      context "when the unix socket has no data to be read" do
-        it_behaves_like "an interruptible input plugin" do
-          let(:run_forever) { false }
+        event = queue.first
+
+        if ecs_select.active_mode == :disabled
+          expect( event.get('host') ).to be_a String
+          expect( event.get('path') ).to eql temp_path
+        else
+          expect( event.get('[host][name]') ).to be_a String
+          expect( event.get('[file][path]') ).to eql temp_path
+          expect( event.include?('path') ).to be false
         end
+
+        expect( event.get('message') ).to eql 'foo'
       end
+
     end
 
   end
+
 end

data/spec/spec_helper.rb

@@ -6,8 +6,9 @@ class UnixSocketHelper
 
   attr_reader :path
 
-  def initialize
+  def initialize(line = 'hi!')
     @socket = nil
+    @line = line
   end
 
   def new_socket(path)
@@ -21,9 +22,9 @@ class UnixSocketHelper
     @thread = Thread.new do
       begin
         s = @socket.accept
-        s.puts "hi" while forever
-      rescue Errno::EPIPE, Errno::ECONNRESET
-        # ...
+        s.puts @line while forever
+      rescue Errno::EPIPE, Errno::ECONNRESET => e
+        warn e.inspect if $VERBOSE
       end
     end
     self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-unix
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +30,20 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: logstash-mixin-ecs_compatibility_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -98,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Reads events over a UNIX socket