logstash-input-exec 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4508358dc14aef0cf2440ee8271b24bed40e68cd7eb267fed59b003c16ea2f1
-  data.tar.gz: b25462749761171d93fafa8245da8d91a227039a6098d11abc752d830bc0422a
+  metadata.gz: e9a1739a5a30aaaa767c2c473943a5825bc056d6359ce52f6dac9972ced8b7e6
+  data.tar.gz: 686879e94a257b42ef068d3e4fe0f48693b62326acb5e9b37cbf12c7046757a6
 SHA512:
-  metadata.gz: d349bbc80698e10aa8561b69a1ddc734c99b557d97e0c4ae5d0ad4a160fe7c80ad325ac68cf66239bdb45f1fd699a40b8ab2e08bd852a34ff436e982a269d5f3
-  data.tar.gz: 4db1b2a03280489a94f5317e0a3a65175a93c0e7b6fadee012fbdfda0c5357f2fd6507a55d9b5b45ab5cdf81f75c515bd819ee881bdbdadc9f7a7789ad957298
+  metadata.gz: a6dc50f96efae3f9eb3e2c777a2ff7afd82d67ebfef2a294887b569127ceac53980291d834ca16576a1a17cbbd7be39346850d15c5d4f93e3e2040df931eeba4
+  data.tar.gz: c0cc7f534112ee308e1c4f8f9f174672b955998e6ae3f80d15689adecdb6d10cd31e508dda9a4d8d693e4c6d80aa460d24aebbf6f807bdb31b4245ec65a7097e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.0
+  - Add 'schedule' option to schedule the command to run, using a cron expression
+
 ## 3.1.5
   - Update gemspec summary
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+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.

data/docs/index.asciidoc

@@ -28,6 +28,21 @@ Notes:
 * The `message` field of this event will be the entire stdout of the command.
 
 
+Example:
+
+[source,ruby]
+----------------------------------
+input {
+  exec {
+    command => "ls"
+    interval => 30
+  }
+}
+----------------------------------
+
+This will execute `ls` command every 30 seconds.
+
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== Exec Input Configuration Options
 
@@ -37,7 +52,8 @@ 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}-interval>> |<<number,number>>|Yes
+| <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-schedule>> |<<string,string>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -57,12 +73,35 @@ Command to run. For example, `uptime`
 [id="plugins-{type}s-{plugin}-interval"]
 ===== `interval` 
 
-  * This is a required setting.
-  * Value type is <<number,number>>
+  * Value type is <<string,string>>
   * There is no default value for this setting.
 
 Interval to run the command. Value is in seconds.
 
+Either `interval` or `schedule` option must be defined.
+
+[id="plugins-{type}s-{plugin}-schedule"]
+===== `schedule` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+Schedule of when to periodically run command.
+
+This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
+The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support).
+
+Examples:
+
+|==========================================================
+| `* 5 * 1-3 *`               | will execute every minute of 5am every day of January through March.
+| `0 * * * *`                 | will execute on the 0th minute of every hour every day.
+| `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
+|==========================================================
+
+Further documentation describing this syntax can be found https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
+
+Either `interval` or `schedule` option must be defined.
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

data/lib/logstash/inputs/exec.rb

@@ -3,6 +3,7 @@ require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket" # for Socket.gethostname
 require "stud/interval"
+require "rufus/scheduler"
 
 # Periodically run a shell command and capture the whole output as an event.
 #
@@ -17,22 +18,41 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
   default :codec, "plain"
 
-  # Command to run. For example, `uptime`
+  # Command to run. For example : `uptime`
   config :command, :validate => :string, :required => true
 
   # Interval to run the command. Value is in seconds.
-  config :interval, :validate => :number, :required => true
+  # Either `interval` or `schedule` option must be defined.
+  config :interval, :validate => :number
+
+  # Schedule of when to periodically run command, in Cron format
+  # For example: "* * * * *" (execute command every minute, on the minute)
+  # Either `interval` or `schedule` option must be defined.
+  config :schedule, :validate => :string
 
   def register
-    @logger.info("Registering Exec Input", :type => @type, :command => @command, :interval => @interval)
+    @logger.info("Registering Exec Input", :type => @type, :command => @command, :interval => @interval, :schedule => @schedule)
     @hostname = Socket.gethostname
     @io       = nil
+    
+    if (@interval.nil? && @schedule.nil?) || (@interval && @schedule)
+      raise LogStash::ConfigurationError, "jdbc input: either 'interval' or 'schedule' option must be defined."
+    end
   end # def register
 
   def run(queue)
-    while !stop?
-      inner_run(queue)
-    end # loop
+    if @schedule
+      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
+      @scheduler.cron @schedule do
+        inner_run(queue)
+      end
+      @scheduler.join
+    else
+      while !stop?
+        duration = inner_run(queue)
+        wait_until_end_of_interval(duration)
+      end # loop
+    end
   end # def run
 
   def inner_run(queue)
@@ -42,17 +62,23 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
     @logger.debug? && @logger.debug("Command completed", :command => @command, :duration => duration)
 
-    wait_until_end_of_interval(duration)
+    return duration
   end
 
   def stop
+    close_io()
+    @scheduler.shutdown(:wait) if @scheduler
+  end
+
+  private
+
+  # Close @io
+  def close_io
     return if @io.nil? || @io.closed?
     @io.close
     @io = nil
   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)
@@ -87,7 +113,7 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
       @logger.error("Exception while running command",
         :command => command, :e => e, :backtrace => e.backtrace)
     ensure
-      stop
+      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.1.5'
+  s.version         = '3.2.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"
@@ -23,7 +23,9 @@ Gem::Specification.new do |s|
   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-codec-plain'
+  s.add_runtime_dependency 'rufus-scheduler'
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'timecop'
 end
 

data/spec/inputs/exec_spec.rb

@@ -1,13 +1,20 @@
 # encoding: utf-8
+require "timecop"
+require "time"
 require_relative "../spec_helper"
 
 describe LogStash::Inputs::Exec do
 
-  it "should register" do
-    input = LogStash::Plugin.lookup("input", "exec").new("command" => "ls", "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
+  context "when register" do
+    it "should not raise error if config is valid" do
+      input = LogStash::Plugin.lookup("input", "exec").new("command" => "ls", "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
+    it "should raise error if config is invalid" do
+      input = LogStash::Plugin.lookup("input", "exec").new("command" => "ls")
+      expect {input.register}.to raise_error
+    end
   end
 
   context "when operating normally" do
@@ -35,6 +42,30 @@ describe LogStash::Inputs::Exec do
     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)
+      runner = Thread.new do
+        input.run(queue)
+      end
+      sleep 3
+      input.stop
+      runner.kill
+      runner.join
+      expect(queue.size).to eq(2)
+      Timecop.return
+    end
+  
+  end
+
   context "when interrupting the plugin" do
 
     it_behaves_like "an interruptible input plugin" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -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'
+  name: rufus-scheduler
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -72,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: timecop
+  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/logstash-plugin install gemname. This
   gem is not a stand-alone program
@@ -113,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Captures the output of a shell command as an event