logstash-input-exec 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a1739a5a30aaaa767c2c473943a5825bc056d6359ce52f6dac9972ced8b7e6
-  data.tar.gz: 686879e94a257b42ef068d3e4fe0f48693b62326acb5e9b37cbf12c7046757a6
+  metadata.gz: ce9ee9b0271289948781bc4b076ab78e944c873d43a66ee3c0dd24a51d82e255
+  data.tar.gz: b91a2de52e523b0f1299582f01502d8c07046979772a413ff9aa5c5a917e9e27
 SHA512:
-  metadata.gz: a6dc50f96efae3f9eb3e2c777a2ff7afd82d67ebfef2a294887b569127ceac53980291d834ca16576a1a17cbbd7be39346850d15c5d4f93e3e2040df931eeba4
-  data.tar.gz: c0cc7f534112ee308e1c4f8f9f174672b955998e6ae3f80d15689adecdb6d10cd31e508dda9a4d8d693e4c6d80aa460d24aebbf6f807bdb31b4245ec65a7097e
+  metadata.gz: 3c58e64c70dc75fff5fb89bb3648bbb52410a2cb35571ce72188b08b466e0db3ee5efc3436e1cf24dc1dd1182b553c3afae07789bc9e5edd9e780fa8b8d6749a
+  data.tar.gz: 8ea6953772bbc385bd4664ff900fc6cb68bb870154ed31197996150f821724ace54ab43e646a283d6677e80b11cd737ae85b60258d72bb5241fa78197043698e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.3.0
+  - Add metadata data to the event wrt execution duration and exit status
+
 ## 3.2.0
   - Add 'schedule' option to schedule the command to run, using a cron expression
 

data/lib/logstash/inputs/exec.rb

@@ -44,34 +44,65 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
     if @schedule
       @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
       @scheduler.cron @schedule do
-        inner_run(queue)
+        execute(queue)
       end
       @scheduler.join
     else
       while !stop?
-        duration = inner_run(queue)
+        duration = execute(queue)
         wait_until_end_of_interval(duration)
       end # loop
     end
   end # def run
 
-  def inner_run(queue)
+  def stop
+    close_io()
+    @scheduler.shutdown(:wait) if @scheduler
+  end
+
+  # Execute a given command
+  # @param [String] A command string
+  # @param [Array or Queue] A queue to append events to
+  def execute(queue)
     start = Time.now
-    execute(@command, queue)
+    output = exit_status = nil
+    begin
+      @logger.debug? && @logger.debug("Running exec", :command => @command)
+      output, exit_status = run_command()
+    rescue StandardError => e
+      @logger.error("Error while running command",
+        :command => @command, :e => e, :backtrace => e.backtrace)
+    rescue Exception => e
+      @logger.error("Exception while running command",
+        :command => @command, :e => e, :backtrace => e.backtrace)
+    end
     duration = Time.now - start
-
     @logger.debug? && @logger.debug("Command completed", :command => @command, :duration => duration)
-
-    return duration
+    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)
+        queue << event
+      end
+    end
+    duration
   end
 
-  def stop
+  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
+    [output, exit_status]
+  ensure
     close_io()
-    @scheduler.shutdown(:wait) if @scheduler
   end
 
-  private
-
   # Close @io
   def close_io
     return if @io.nil? || @io.closed?
@@ -93,27 +124,5 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
     end
   end
 
-  # Execute a given command
-  # @param [String] A command string
-  # @param [Array or Queue] A queue to append events to
-  def execute(command, queue)
-    @logger.debug? && @logger.debug("Running exec", :command => command)
-    begin
-      @io = IO.popen(command)
-      @codec.decode(@io.read) do |event|
-        decorate(event)
-        event.set("host", @hostname)
-        event.set("command", command)
-        queue << event
-      end
-    rescue StandardError => e
-      @logger.error("Error while running command",
-        :command => command, :e => e, :backtrace => e.backtrace)
-    rescue Exception => e
-      @logger.error("Exception while running command",
-        :command => command, :e => e, :backtrace => e.backtrace)
-    ensure
-      close_io()
-    end
-  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.2.0'
+  s.version         = '3.3.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"

data/spec/inputs/exec_spec.rb

@@ -36,20 +36,45 @@ describe LogStash::Inputs::Exec do
       input.register
       expect(loggr).not_to receive(:error)
 
-      input.inner_run(queue)
+      input.execute(queue)
 
       expect(queue.size).not_to be_zero
     end
   end
 
+  context "when a command runs normally" do
+    let(:input) { LogStash::Plugin.lookup("input", "exec").new("command" => "/bin/sh -c 'sleep 1; /bin/echo -n two; exit 3'", "interval" => 0) }
+    let(:queue) { [] }
+
+    before do
+      input.register
+      input.execute(queue)
+    end
+
+    after do
+      input.stop
+    end
+
+    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"
+    end
+    it "has exit_status tracked" do
+      expect(queue.pop.get('[@metadata][exit_status]')).to eq 3
+    end
+
+  end
+
   context "when scheduling" do
     let(:input) { LogStash::Plugin.lookup("input", "exec").new("command" => "ls", "schedule" => "* * * * * UTC") }
     let(:queue) { [] }
-  
+
     before do
       input.register
     end
-  
+
     it "should properly schedule" do
       Timecop.travel(Time.new(2000))
       Timecop.scale(60)
@@ -63,7 +88,6 @@ describe LogStash::Inputs::Exec do
       expect(queue.size).to eq(2)
       Timecop.return
     end
-  
   end
 
   context "when interrupting the plugin" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement