logstash-input-exec 3.3.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 454a3fd142d85a04a0e93b3054d6f300d9dbbe7f02013485e2e58d12c5aba3d3
-  data.tar.gz: c2a32db4b81afc9429beee70d704b7b2cb737b08b924f813a5e91e5de4fd709d
+  metadata.gz: 01d8e2cf6057c8c259d53f056dab08b583d222b367adda70a80a045eac7fa08d
+  data.tar.gz: 30536c1078190608e0894f9e018dc70cb7fffe0b72ce80ed08a36294d804def8
 SHA512:
-  metadata.gz: 983904e90f7ba90ecae393cdda1fa39abb093bc923ca82f63c70dc818b48edc36211926a6848a7c48a7547f17e0d96b7bb7a21d0f353768c064f5d2f17eab7b5
-  data.tar.gz: 3e7e26cde26f98fcbe1d3e0a752dec41729135c85d49720197d2a1d018c97898188bbe27fcd73290c0169d68d7263b8b6d270f6c95a8012d22a35dda47cf10b4
+  metadata.gz: cf1aa23f2e652c11dbdf22cfb78a1831ab0965befa58b69fbef3d83e71f85e65e98f48d71363df258aa087d9d01f0fdc43b784ec8ee4a38631af5d0615aee467
+  data.tar.gz: d517483d728e1c59f99bbce6318aeb685f0933e8300d1fbc144362c4828a40c67015edcaefe735b44c12b08f9a6ffff01e208cb3f6779581afc8cc7d37a2c407

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.6.0
+  - Refactor: start using scheduler mixin [#33](https://github.com/logstash-plugins/logstash-input-exec/pull/33)
+  - Fix: Test failures due to insufficient time given for scheduler to start [#32](https://github.com/logstash-plugins/logstash-input-exec/pull/32) 
+
+## 3.5.0
+  - Fix: behavior incompatiblity between (standalone) LS and LS in Docker [#30](https://github.com/logstash-plugins/logstash-input-exec/pull/30)
+
+## 3.4.0
+  - Feat: adjust fields for ECS compatibility [#28](https://github.com/logstash-plugins/logstash-input-exec/pull/28)
+  - Plugin will no longer override fields if they exist in the decoded payload.
+    (It no longer sets the `host` field if decoded from the command's output.)
+
+## 3.3.3
+  - Docs: improved doc on memory usage [#27](https://github.com/logstash-plugins/logstash-input-exec/pull/27)
+
 ## 3.3.2
   - Fixed issue where certain log entries were incorrectly writing 'jdbc input' instead of 'exec input' [#21](https://github.com/logstash-plugins/logstash-input-exec/pull/21)
 

data/CONTRIBUTORS

@@ -3,6 +3,7 @@ reports, or in general have helped logstash along its way.
 
 Contributors:
 * Christoph Mertz (cmertz)
+* Colin Surprenant (colinsurprenant)
 * John E. Vincent (lusis)
 * Jordan Sissel (jordansissel)
 * Nick Ethier (nickethier)

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-exec.svg)](https://travis-ci.org/logstash-plugins/logstash-input-exec)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-exec.svg)](https://travis-ci.com/logstash-plugins/logstash-input-exec)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -23,10 +23,15 @@ include::{include_path}/plugin_header.asciidoc[]
 
 Periodically run a shell command and capture the whole output as an event.
 
-Notes:
-
+[NOTE]
+========
 * The `command` field of this event will be the command run.
 * The `message` field of this event will be the entire stdout of the command.
+========
+
+IMPORTANT: The exec input ultimately uses `fork` to spawn a child process.
+Using fork duplicates the parent process address space (in our case, **logstash and the JVM**); this is mitigated with OS copy-on-write but ultimately you can end up allocating lots of memory just for a "simple" executable.
+If the exec input fails with errors like `ENOMEM: Cannot allocate memory` it is an indication that there is not enough non-JVM-heap physical memory to perform the fork.
 
 
 Example:
@@ -35,17 +40,36 @@ Example:
 ----------------------------------
 input {
   exec {
-    command => "ls"
+    command => "echo 'hi!'"
     interval => 30
   }
 }
 ----------------------------------
 
-This will execute `ls` command every 30 seconds.
+This will execute `echo` command every 30 seconds.
+
+[id="plugins-{type}s-{plugin}-ecs"]
+==== Compatibility with the Elastic Common Schema (ECS)
+
+This plugin adds metadata about the event's source, and can be configured to do so
+in an {ecs-ref}[ECS-compatible] way with <<plugins-{type}s-{plugin}-ecs_compatibility>>.
+This metadata is 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
+| `[@metadata][exit_status]` | `[process][exit_code]`    | The exit code of the process
+| --                         | `[@metadata][input][exec][process][elapsed_time]`
+                                                         | The elapsed time the command took to run in nanoseconds
+| `[@metadata][duration]`    | --                        | Command duration in seconds as a floating point number (deprecated)
+|========
 
 
 [id="plugins-{type}s-{plugin}-options"]
-==== Exec Input Configuration Options
+==== Exec Input configuration options
 
 This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
 
@@ -53,6 +77,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
 | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-schedule>> |<<string,string>>|No
 |=======================================================================
@@ -71,6 +96,58 @@ input plugins.
 
 Command to run. For example, `uptime`
 
+[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]
+-----
+{
+    "message" => "hi!\n",
+    "process" => {
+        "command_line" => "echo 'hi!'",
+        "exit_code" => 0
+    },
+    "host" => {
+        "name" => "deus-ex-machina"
+    },
+
+    "@metadata" => {
+        "input" => {
+            "exec" => {
+                "process" => {
+                    "elapsed_time"=>3042
+                }
+            }
+        }
+    }
+}
+-----
+
+**Sample output: ECS disabled**
+[source,ruby]
+-----
+{
+    "message" => "hi!\n",
+    "command" => "echo 'hi!'",
+    "host" => "deus-ex-machina",
+
+    "@metadata" => {
+        "exit_status" => 0,
+        "duration" => 0.004388
+    }
+}
+-----
+
 [id="plugins-{type}s-{plugin}-interval"]
 ===== `interval` 
 

data/lib/logstash/inputs/exec.rb

@@ -1,9 +1,12 @@
 # encoding: utf-8
 require "logstash/inputs/base"
 require "logstash/namespace"
+require "open3"
 require "socket" # for Socket.gethostname
 require "stud/interval"
-require "rufus/scheduler"
+
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+require "logstash/plugin_mixins/scheduler"
 
 # Periodically run a shell command and capture the whole output as an event.
 #
@@ -14,6 +17,9 @@ require "rufus/scheduler"
 #
 class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+  include LogStash::PluginMixins::Scheduler
+
   config_name "exec"
 
   default :codec, "plain"
@@ -31,22 +37,25 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   config :schedule, :validate => :string
 
   def register
-    @logger.info("Registering Exec Input", :type => @type, :command => @command, :interval => @interval, :schedule => @schedule)
-    @hostname = Socket.gethostname
-    @io       = nil
-    
+    @hostname = Socket.gethostname.freeze
+
     if (@interval.nil? && @schedule.nil?) || (@interval && @schedule)
       raise LogStash::ConfigurationError, "exec input: either 'interval' or 'schedule' option must be defined."
     end
+
+    @host_name_field =            ecs_select[disabled: 'host',                     v1: '[host][name]']
+    @process_command_line_field = ecs_select[disabled: 'command',                  v1: '[process][command_line]']
+    @process_exit_code_field =    ecs_select[disabled: '[@metadata][exit_status]', v1: '[process][exit_code]']
+    
+    # migrate elapsed time tracking to whole nanos, from legacy floating-point fractional seconds
+    @process_elapsed_time_field = ecs_select[disabled: nil,                        v1: '[@metadata][input][exec][process][elapsed_time]'] # in nanos
+    @legacy_duration_field =      ecs_select[disabled: '[@metadata][duration]',    v1: nil] # in seconds
   end # def register
 
   def run(queue)
     if @schedule
-      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
-      @scheduler.cron @schedule do
-        execute(queue)
-      end
-      @scheduler.join
+      scheduler.cron(@schedule) { execute(queue) }
+      scheduler.join
     else
       while !stop?
         duration = execute(queue)
@@ -56,13 +65,11 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   end # def run
 
   def stop
-    close_io()
-    @scheduler.shutdown(:wait) if @scheduler
+    close_out_and_in
   end
 
   # Execute a given command
-  # @param [String] A command string
-  # @param [Array or Queue] A queue to append events to
+  # @param queue the LS queue to append events to
   def execute(queue)
     start = Time.now
     output = exit_status = nil
@@ -71,20 +78,21 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
       output, exit_status = run_command()
     rescue StandardError => e
       @logger.error("Error while running command",
-        :command => @command, :e => e, :backtrace => e.backtrace)
+        :command => @command, :exception => e, :backtrace => e.backtrace)
     rescue Exception => e
       @logger.error("Exception while running command",
-        :command => @command, :e => e, :backtrace => e.backtrace)
+        :command => @command, :exception => e, :backtrace => e.backtrace)
     end
-    duration = Time.now - start
-    @logger.debug? && @logger.debug("Command completed", :command => @command, :duration => duration)
+    duration = Time.now.to_r - start.to_r
+    @logger.debug? && @logger.debug("Command completed", :command => @command, :duration => duration.to_f)
     if output
       @codec.decode(output) do |event|
         decorate(event)
-        event.set("host", @hostname)
-        event.set("command", @command)
-        event.set("[@metadata][duration]", duration)
-        event.set("[@metadata][exit_status]", exit_status)
+        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)
+        event.set(@process_exit_code_field, exit_status) unless event.include?(@process_exit_code_field)
+        event.set(@process_elapsed_time_field, to_nanos(duration)) if @process_elapsed_time_field
+        event.set(@legacy_duration_field, duration.to_f) if @legacy_duration_field
         queue << event
       end
     end
@@ -94,24 +102,30 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   private
 
   def run_command
-    @io = IO.popen(@command)
-    output = @io.read
-    @io.close # required in order to read $?
-    exit_status = $?.exitstatus # should be threadsafe as per rb_thread_save_context
+    @p_in, @p_out, waiter = Open3.popen2(@command)
+    output = @p_out.read
+    exit_status = waiter.value.exitstatus
     [output, exit_status]
   ensure
-    close_io()
+    close_out_and_in
   end
 
-  # Close @io
-  def close_io
-    return if @io.nil? || @io.closed?
-    @io.close
-    @io = nil
+  def close_out_and_in
+    close_io(@p_out)
+    @p_out = nil
+    close_io(@p_in)
+    @p_in = nil
+  end
+
+  def close_io(io)
+    return if io.nil? || io.closed?
+    io.close
+  rescue => e
+    @logger.debug("ignoring exception raised while closing io", :io => io, :exception => e.class, :message => e.message)
   end
 
   # Wait until the end of the interval
-  # @param [Integer] the duration of the last command executed
+  # @param duration [Integer] the duration of the last command executed
   def wait_until_end_of_interval(duration)
     # Sleep for the remainder of the interval, or 0 if the duration ran
     # longer than the interval.
@@ -124,5 +138,10 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
     end
   end
 
+  # convert seconds to nanoseconds
+  # @param time_diff [Numeric] the (rational value) difference to convert
+  def to_nanos(time_diff)
+    (time_diff * 1_000_000).to_i
+  end
 
 end # class LogStash::Inputs::Exec

data/logstash-input-exec.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-exec'
-  s.version         = '3.3.2'
+  s.version         = '3.6.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Captures the output of a shell command as an event"
   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,9 +21,11 @@ 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-mixin-scheduler", '~> 1.0'
+
   s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'rufus-scheduler'
 
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'timecop'

data/spec/inputs/exec_spec.rb

@@ -2,93 +2,142 @@
 require "timecop"
 require "time"
 require_relative "../spec_helper"
+require "logstash/devutils/rspec/shared_examples"
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
 
-describe LogStash::Inputs::Exec do
+describe LogStash::Inputs::Exec, :ecs_compatibility_support do
 
-  context "when register" do
-    let(:input) { described_class.new("command" => "ls", "interval" => 0) }
-    it "should not raise error if config is valid" do
-      # register will try to load jars and raise if it cannot find jars or if org.apache.log4j.spi.LoggingEvent class is not present
-      expect {input.register}.to_not raise_error
+  ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+    before(:each) do
+      allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
     end
-    context "with an invalid config" do
-      let(:input) { described_class.new("command" => "ls") }
-      it "should raise error" do
-        expect {input.register}.to raise_error(LogStash::ConfigurationError)
+
+    context "when register" do
+      let(:input) { described_class.new("command" => "ls", "interval" => 0) }
+
+      it "should not raise error if config is valid" do
+        # register will try to load jars and raise if it cannot find jars or if org.apache.log4j.spi.LoggingEvent class is not present
+        expect { input.register }.to_not raise_error
       end
-    end
-  end
 
-  context "when operating normally" do
-    let(:input) { described_class.new("command" => "ls", "interval" => 0) }
-    let(:queue) { [] }
-    let(:loggr) { double('loggr') }
-
-    before :each do
-      expect(described_class).to receive(:logger).and_return(loggr).exactly(7).times
-      allow(loggr).to receive(:info)
-      allow(loggr).to receive(:info?)
-      allow(loggr).to receive(:warn)
-      allow(loggr).to receive(:warn?)
-      allow(loggr).to receive(:debug)
-      allow(loggr).to receive(:debug?)
+      context "with an invalid config" do
+        let(:input) { described_class.new("command" => "ls") }
+        it "should raise error" do
+          expect { input.register }.to raise_error(LogStash::ConfigurationError)
+        end
+      end
     end
 
-    it "enqueues some events" do
-      input.register
-      expect(loggr).not_to receive(:error)
+    context "when operating normally" do
+      let(:input) { described_class.new("command" => "echo 'hi!'", "interval" => 0) }
+      let(:queue) { [] }
 
-      input.execute(queue)
+      before :each do
+        input.register
+      end
 
-      expect(queue.size).not_to be_zero
-    end
-  end
+      it "enqueues some events" do
+        expect(input.logger).not_to receive(:error)
 
-  context "when a command runs normally" do
-    let(:input) { described_class.new("command" => "/bin/sh -c 'sleep 1; /bin/echo -n two; exit 3'", "interval" => 0) }
-    let(:queue) { [] }
+        input.execute(queue)
 
-    before do
-      input.register
-      input.execute(queue)
+        expect(queue.size).not_to be_zero
+      end
     end
 
-    after do
-      input.stop
-    end
+    context "when command fails" do
+      let(:input) { described_class.new("command" => "invalid_command 1 2 3", "interval" => 0) }
+      let(:queue) { [] }
 
-    it "has duration tracked" do
-      expect(queue.pop.get('[@metadata][duration]')).to be > 1
-    end
-    it "has output as expected" do
-      expect(queue.pop.get('message')).to eq "two"
+      before :each do
+        input.register
+      end
+
+      it "does not enqueue an event (in a non-Docker env)" do
+        expect(input.logger).to receive(:error).and_call_original
+
+        input.execute(queue)
+
+        expect(queue.map(&:to_hash)).to be_empty
+      end
     end
-    it "has exit_status tracked" do
-      expect(queue.pop.get('[@metadata][exit_status]')).to eq 3
+
+    context "when a command runs normally" do
+      let(:command) { "/bin/sh -c 'sleep 1; /bin/echo -n two; exit 3'" }
+      let(:input) { described_class.new("command" => command, "interval" => 0) }
+      let(:queue) { [] }
+
+      before do
+        input.register
+        input.execute(queue)
+      end
+
+      after do
+        input.stop
+      end
+
+      it "has duration (in seconds)" do
+        duration = queue.pop.get('[@metadata][duration]')
+        expect(duration).to be_a Float
+        expect(duration).to be > 1
+        expect(duration).to be < 3
+      end if ecs_select.active_mode == :disabled
+
+      it "reports process elapsed time (in nanos)" do
+        elapsed_time = queue.pop.get('[@metadata][input][exec][process][elapsed_time]')
+        expect(elapsed_time).to be_a Integer
+        expect(elapsed_time).to be > 1 * 1_000_000
+        expect(elapsed_time).to be < 3 * 1_000_000
+      end if ecs_select.active_mode != :disabled
+
+      it "has output as expected" do
+        expect(queue.pop.get('message')).to eq "two"
+      end
+
+      it "reports process command_line  " do
+        if ecs_select.active_mode == :disabled
+          expect(queue.pop.get('command')).to eql command
+        else
+          expect(queue.pop.get('[process][command_line]')).to eql command
+        end
+      end
+
+      it "reports process exit_code" do
+        if ecs_select.active_mode == :disabled
+          expect(queue.pop.get('[@metadata][exit_status]')).to eq 3
+        else
+          expect(queue.pop.get('[process][exit_code]')).to eq 3
+        end
+      end
+
     end
 
   end
 
   context "when scheduling" do
-    let(:input) { described_class.new("command" => "ls", "schedule" => "* * * * * UTC") }
+    let(:input) { described_class.new("command" => "ls --help", "schedule" => "5-6 * * * * UTC") }
     let(:queue) { [] }
 
     before do
+      Timecop.travel(Time.new(2000))
+      Timecop.scale(60)
       input.register
     end
 
+    after do
+      Timecop.return
+    end
+
     it "should properly schedule" do
-      Timecop.travel(Time.new(2000))
-      Timecop.scale(60)
       runner = Thread.new do
         input.run(queue)
       end
-      sleep 3
+      sleep 10
       input.stop
       runner.kill
       runner.join
       expect(queue.size).to eq(2)
-      Timecop.return
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.6.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,36 +35,50 @@ 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:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-codec-plain
+        version: '1.0'
+  name: logstash-mixin-scheduler
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.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:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rufus-scheduler
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
@@ -140,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Captures the output of a shell command as an event