logstash-input-pipe 3.0.7 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2509bb96f79e3d37be9f8e05ecd55165afed3a43a21e24c4d71bb1f3c613c08e
-  data.tar.gz: 2c0a565f83b417b2119f829199e9e5c4c207f4eb5bf1804b5a67be492f6f35d1
+  metadata.gz: 208adad7453aceb2e61a82d66ea6e4c41d5911e4c9cf3210d9bd538f71f5463a
+  data.tar.gz: b84fd20fd37f2083c219a69b5558de72ed96317f92c313634754cfa4b83f9e3b
 SHA512:
-  metadata.gz: 25cf6a651a805a58f91735b2397dc953f1a85bde78878674519095c70ca8b7e49389896812cc4c7bf59b156fc356c60c81283c35725eca008d52b1cb79bb4105
-  data.tar.gz: aa4e9c58e60a6514a558f8d61fb1816ab54910ad22f4c3d79f3e208d20b08c84ab1bed1b43ec0d8f81ff3feae62de4f9aaac1ca6f2275f878dcd4bc7a6759eb8
+  metadata.gz: e49b649630a3fdd52ec11b9b445fb0aca83cc61dc2cbd16e0bc16d29545db9d116176c0567581830a3c26ba45e0e4bf9bd09b47fbf796e0c454cd23d2c423caa
+  data.tar.gz: 9be37cf53ea5828a6bf9344e88505277668c131d7b0d69a08790d1b0867aae3d21a279ecf0b7d1e10983096ed6c9a0a08f385d4ceffdc065727937e3b3432bbf

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+  -  Feat: adjust fields for ECS compatibility [#19](https://github.com/logstash-plugins/logstash-input-pipe/pull/19)
+
 ## 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-pipe.svg)](https://travis-ci.org/logstash-plugins/logstash-input-pipe)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-pipe.svg)](https://travis-ci.com/logstash-plugins/logstash-input-pipe)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -27,6 +27,23 @@ By default, each event is assumed to be one line. If you
 want to join lines, you'll want to use the multiline codec.
 
 
+[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
+| `command`    | `[process][command_line]` | The command run by the plugin
+|========
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== Pipe Input Configuration Options
 
@@ -36,6 +53,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-command>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -54,8 +72,51 @@ Command to run and read events from, one line at a time.
 
 Example:
 [source,ruby]
-   command => "echo hello world"
+-----
+input {
+  pipe {
+    command => "echo ¡Hola!"
+  }
+}
+-----
+
+[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-16T09:18:45.306Z,
+    "message" => "¡Hola!",
+    "process" => {
+        "command_line" => "echo '¡Hola!'"
+    },
+    "host" => {
+        "name" => "deus-ex-machina"
+    }
+}
+-----
+
+**Sample output: ECS disabled**
+[source,ruby]
+-----
+{
+    "@timestamp"=>2021-11-16T09:18:45.306Z,
+    "message" => "¡Hola!",
+    "command" => "echo '¡Hola!'",
+    "host" => "deus-ex-machina"
+}
+-----
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

data/lib/logstash/inputs/pipe.rb

@@ -8,12 +8,17 @@ require "logstash/namespace"
 require "socket" # for Socket.gethostname
 require "stud/interval"
 
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+
 # Stream events from a long running command pipe.
 #
 # By default, each event is assumed to be one line. If you
 # want to join lines, you'll want to use the multiline codec.
 #
 class LogStash::Inputs::Pipe < LogStash::Inputs::Base
+
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+
   config_name "pipe"
 
   # TODO(sissel): This should switch to use the `line` codec by default
@@ -34,30 +39,35 @@ class LogStash::Inputs::Pipe < LogStash::Inputs::Base
 
   public
   def register
-    @logger.info("Registering pipe input", :command => @command)
+    @logger.debug("Registering pipe input", :command => @command)
+
+    @hostname = Socket.gethostname.freeze
+
+    @host_name_field =            ecs_select[disabled: 'host',    v1: '[host][name]']
+    @process_command_line_field = ecs_select[disabled: 'command', v1: '[process][command_line]']
   end # def register
 
   public
   def run(queue)
     while !stop?
       begin
-        @pipe = IO.popen(@command, "r")
-        hostname = Socket.gethostname
+        pipe = @pipe = IO.popen(@command, "r")
 
-        @pipe.each do |line|
+        pipe.each do |line|
           line = line.chomp
           @logger.debug? && @logger.debug("Received line", :command => @command, :line => line)
+
           @codec.decode(line) do |event|
-            event.set("host", hostname)
-            event.set("command", @command)
             decorate(event)
+            event.set(@host_name_field, @hostname) unless event.include?(@host_name_field)
+            event.set(@process_command_line_field, @command) unless event.include?(@process_command_line_field)
             queue << event
           end
         end
-        @pipe.close
+        pipe.close
         @pipe = nil
       rescue Exception => e
-        @logger.error("Exception while running command", :e => e, :backtrace => e.backtrace)
+        @logger.error("Exception while running command", :exception => e, :backtrace => e.backtrace)
       end
 
       # Keep running the command forever.
@@ -68,9 +78,10 @@ class LogStash::Inputs::Pipe < LogStash::Inputs::Base
   end # def run
 
   def stop
-    if @pipe
-      Process.kill("KILL", @pipe.pid) rescue nil
-      @pipe.close rescue nil
+    pipe = @pipe
+    if pipe
+      Process.kill("KILL", pipe.pid) rescue nil
+      pipe.close rescue nil
       @pipe = nil
     end
   end

data/logstash-input-pipe.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-pipe'
-  s.version         = '3.0.7'
+  s.version         = '3.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Streams events from a long-running command pipe"
   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,10 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency 'stud', '~> 0.0.22'
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
   s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
+
   s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/inputs/pipe_spec.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
 require "logstash/inputs/pipe"
 require "tempfile"
 
@@ -24,25 +26,47 @@ describe LogStash::Inputs::Pipe, :unix => true do
 
   end
 
-  describe "pipe from echo" do
+  describe "pipe from echo", :ecs_compatibility_support do
 
-    let(:config) do <<-CONFIG
-      input {
-        pipe {
-          command => "echo ☹"
+    ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+      let(:config) do <<-CONFIG
+        input {
+          pipe {
+            command => "echo ☹"
+            ecs_compatibility => "#{ecs_compatibility}"
+          }
         }
-      }
-    CONFIG
-    end
+      CONFIG
+      end
 
-    let(:event) do
-      input(config) do |pipeline, queue|
-        queue.pop
+      let(:event) do
+        input(config) do |pipeline, queue|
+          queue.pop
+        end
+      end
+
+      it "should receive the pipe" do
+        expect(event.get("message")).to eq("☹")
+      end
+
+      it "sets host field" do
+        if ecs_select.active_mode == :disabled
+          expect(event.get("host")).to be_a String
+        else
+          expect(event.get("[host][name]")).to be_a String
+        end
+      end
+
+      it "sets the command executed" do
+        if ecs_select.active_mode == :disabled
+          expect(event.get("command")).to eql "echo ☹"
+        else
+          expect(event.include?("command")).to be false
+          expect(event.get("[process][command_line]")).to eql "echo ☹"
+        end
       end
-    end
 
-    it "should receive the pipe" do
-      expect(event.get("message")).to eq("☹")
     end
 
   end
@@ -74,9 +98,8 @@ describe LogStash::Inputs::Pipe, :unix => true do
     end
 
     it "should receive all piped elements" do
-      event_count.times do |i|
-        expect(events[i].get("message")).to eq("#{i} ☹")
-      end
+      messages = event_count.times.map { |i| events[i].get("message") }
+      expect( messages.sort ).to eql event_count.times.map { |i| "#{i} ☹" }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-pipe
 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-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,15 +35,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.22
-  name: stud
+        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: 0.0.22
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -111,8 +125,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: Streams events from a long-running command pipe