Class: LogStash::Inputs::Exec

Inherits:
Base
  • Object
show all
Defined in:
lib/logstash/inputs/exec.rb

Overview

Run command line tools 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.

Instance Method Summary collapse

Instance Method Details

#register ⇒ Object 



30
31
32
33
 
# File 'lib/logstash/inputs/exec.rb', line 30

def register
  @logger.info("Registering Exec Input", :type => @type,
               :command => @command, :interval => @interval)
end

#run(queue) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/logstash/inputs/exec.rb', line 36

def run(queue)
  hostname = Socket.gethostname
  loop do
    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|
      decorate(event)
      event["host"] = hostname
      event["command"] = @command
      queue << event
    end
    out.close

    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