logstash-input-exec 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 305395f9da54e6b5ab85218a1e447767b656e229
-  data.tar.gz: 8acf99875e32728c780aec5ccac84a133e9741f0
+  metadata.gz: eec72b75adc610d7f82a3086724de2d114aef6a2
+  data.tar.gz: 8c3c01dcaa78bcf8f58984e33d94ed94810788d4
 SHA512:
-  metadata.gz: 813e0c6ec7727bbbda346b0dab7890cce02151d56a5b5d3add78de90b6a829d1b61ce3502d781315b788949b8aab516d7bdf21fca1ca49c0c3885b0ea132b3c4
-  data.tar.gz: 2525248c677882dd049ddf80d32481a18320b347863c5c53d437664ce2589a0844ea05aa205831b5fb1b0561bca2f0049c38473b62a62da42e724514a83c566a
+  metadata.gz: 027c87842ed7a3959208afdb526a47fd094aebcea09b19579489dc049d7f1f6b9c61692d79436587f9efcd39b55bbdc23ee990477732277f090ad14f173b5e44
+  data.tar.gz: 265a6eecd2a5ab515ba66276e0c17d1ca1a4da7f9cf54a4c44181cbdb0608b79d0aee06e192fdf581dee61e7514c4ed9c3bd00327d0356bbcf80adef90b68611

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/exec.rb

@@ -2,14 +2,14 @@
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket" # for Socket.gethostname
+require "stud/interval"
 
-# Run command line tools and capture the whole output as an event.
+# Periodically run a shell command and capture the whole output as an event.
 #
 # Notes:
 #
-# * The `@source` of this event will be the command run.
-# * The `@message` of this event will be the entire stdout of the command
-#   as one event.
+# * 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.
 #
 class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
@@ -26,42 +26,66 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   # Interval to run the command. Value is in seconds.
   config :interval, :validate => :number, :required => true
 
-  public
   def register
-    @logger.info("Registering Exec Input", :type => @type,
-                 :command => @command, :interval => @interval)
+    @logger.info("Registering Exec Input", :type => @type, :command => @command, :interval => @interval)
+    @hostname = Socket.gethostname
+    @io       = nil
   end # def register
 
-  public
   def run(queue)
-    hostname = Socket.gethostname
-    loop do
+
+    while !stop?
       start = Time.now
-      @logger.info? && @logger.info("Running exec", :command => @command)
-      out = IO.popen(@command)
-      # out.read will block until the process finishes.
-      @codec.decode(out.read) do |event|
+      execute(@command)
+      duration = Time.now - start
+
+      @logger.info? && @logger.info("Command completed", :command => @command, :duration => duration)
+
+      wait_until_end_of_interval(duration)
+    end # loop
+  end # def run
+
+  def stop
+    if @io
+      @io.close
+      @io = nil
+    end
+  end
+
+  private
+
+  # Wait until the end of the interval
+  # @param [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.
+    sleeptime = [0, @interval - duration].max
+    if sleeptime == 0
+      @logger.warn("Execution ran longer than the interval. Skipping sleep.",
+                   :command => @command, :duration => duration, :interval => @interval)
+    else
+      Stud.stoppable_sleep(sleeptime) { stop? }
+    end
+  end
+
+  # Execute a given command
+  # @param [String] A command string
+  def execute(command)
+    @logger.info? && @logger.info("Running exec", :command => command)
+    begin
+      @io = IO.popen(command)
+      @codec.decode(@io.read) do |event|
         decorate(event)
-        event["host"] = hostname
-        event["command"] = @command
+        event["host"]    = @hostname
+        event["command"] = command
         queue << event
       end
-      out.close
+    rescue Exception => e
+      @logger.error("Exception while running command", :e => e, :backtrace => e.backtrace)
+    ensure
+      @io.close
+      @io = nil
+    end
+  end
 
-      duration = Time.now - start
-      @logger.info? && @logger.info("Command completed", :command => @command,
-                                    :duration => duration)
-
-      # Sleep for the remainder of the interval, or 0 if the duration ran
-      # longer than the interval.
-      sleeptime = [0, @interval - duration].max
-      if sleeptime == 0
-        @logger.warn("Execution ran longer than the interval. Skipping sleep.",
-                     :command => @command, :duration => duration,
-                     :interval => @interval)
-      else
-        sleep(sleeptime)
-      end
-    end # loop
-  end # def run
 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         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Run command line tools and capture the whole output 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/plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/exec_spec.rb

@@ -1 +1,25 @@
-require "logstash/devutils/rspec/spec_helper"
+# encoding: utf-8
+require_relative "../spec_helper"
+
+describe LogStash::Inputs::Exec do
+
+  it "should register" do
+    input = LogStash::Plugin.lookup("input", "exec").new("command" => "uptime", "interval" => 0)
+
+    # 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
+
+  context "when interrupting the plugin" do
+
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { { "command" => "uptime", "interval" => 0 } }
+    end
+
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { { "command" => "uptime", "interval" => 100 } }
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/exec"

metadata

@@ -1,80 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
   name: logstash-core
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.0.snapshot
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/exec.rb
 - logstash-input-exec.gemspec
 - spec/inputs/exec_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -97,9 +104,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Run command line tools and capture the whole output as an event.
 test_files:
 - spec/inputs/exec_spec.rb
+- spec/spec_helper.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"