scout 5.9.7.2.pre → 5.9.8.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 140399efe8eee3eba1aec08b48196a4f87140e31
-  data.tar.gz: 3ba82c2aadc04ddace97c6d33ef1a63b728df903
+  metadata.gz: 194c916c84d7cc8a77e55c249f138e241e2bb640
+  data.tar.gz: 4aadaca0469ba3bddb08393264e39e528a9fc335
 SHA512:
-  metadata.gz: c57acbf53039f8e08e19583939f1c29ba9759ae6d7f25f8f380b65284da397763710d845dc35857571f84969fc9445c550dd6cf1880aec6846629e5929d9dc40
-  data.tar.gz: 6508b1e69bf1b2a6f1aee09950fe114b634abe1955b576fae2fdc4e97f6b59797dd88d4bb6ab69e2311ce321bb6ca3e30ac76224d89344ead1149ce9d5ac7b38
+  metadata.gz: 3ae8da04d1b7dff3e2c0fd7111c481b685d123dd2cd16ea3b97cae5a04a330d336904ca7909dd9421a8e96186a6410e14cbd2cdfd74954e6e56c491fc489c5a5
+  data.tar.gz: 19ef5795f05007fefb8f4a5fab15bdff62da3f9b54fdccd6759fd4196eeea3d740f6e775a6bedacf8be611162375ab0379a3d1cb02afb027f289a666541dc5b6

data/CHANGELOG.markdown

@@ -1,6 +1,6 @@
-# 5.9.7.2
+# 5.9.8
 
-* Convert alert/error/report strings to UTF-8
+* Added Nagios plugin support via the `--nagios` flag.
 
 # 5.9.7.1
 
@@ -9,6 +9,7 @@
 # 5.9.7
 
 * Preliminary support for realtime compatibility with GO agent
+>>>>>>> master
 
 # 5.9.5
 

data/lib/scout.rb

@@ -5,10 +5,12 @@ require "server_metrics"
 
 require "scout/version"
 
-require "scout/helpers"
 require "scout/http"
 require "scout/command"
 require "scout/plugin"
+require "scout/third_party_plugins/third_party_plugins"
+require "scout/third_party_plugins/munin_plugin"
+require "scout/third_party_plugins/nagios_plugin"
 require "scout/plugin_options"
 require "scout/scout_logger"
 require "scout/server_base"

data/lib/scout/command.rb

@@ -97,6 +97,14 @@ module Scout
           options[:environment] = environment
         end
 
+        opts.on( "--nagios [NRPE CONFIG PATH]", "Run Nagios plugins defined in the specified NRPE config file. If no path is provided, plugins are loaded from '/etc/nagios/nrpe.cfg'." ) do |nrpe_config_file_path|
+          options[:nrpe_config_file_path] = nrpe_config_file_path || '/etc/nagios/nrpe.cfg'
+        end
+
+        opts.on( "--munin [MUNIN PLUGIN PATH]", "Load Munin plugins from the specified path. If no path is provided, plugins are loaded from '/etc/munin/plugins'." ) do |munin_plugin_path|
+          options[:munin_plugin_path] = munin_plugin_path || '/etc/munin/plugins'
+        end
+
         opts.separator " "
         opts.separator "Common Options:"
         opts.separator "--------------------------------------------------------------------------"
@@ -184,6 +192,8 @@ module Scout
       @https_proxy    = options[:https_proxy] || ""
       @hostname       = options[:hostname] || Socket.gethostname
       @environment    = options[:environment] || ""
+      @munin_plugin_path = options[:munin_plugin_path]
+      @nrpe_config_file_path = options[:nrpe_config_file_path]
       @options = options
       @args    = args
 

data/lib/scout/command/run.rb

@@ -10,7 +10,7 @@ module Scout
         log.debug("Running Scout [#{Scout::VERSION}] with server_metrics [#{ServerMetrics::VERSION}] on #{@hostname}") if log
         log.debug("Configuration directory is #{configuration_directory} ") if log
         # TODO: too much external logic of command doing things TO server. This should be moved into the server class.
-        @scout = Scout::Server.new(server, key, history, log, server_name, @http_proxy, @https_proxy, @roles, @hostname, @environment)
+        @scout = Scout::Server.new(server, key, history, log, server_name, @http_proxy, @https_proxy, @roles, @hostname, @environment, @munin_plugin_path, @nrpe_config_file_path)
         @scout.load_history
         
         unless $stdin.tty?

data/lib/scout/plugin.rb

@@ -116,17 +116,17 @@ module Scout
         
         if "#{kind}" == "report"
           def report(new_entry)
-            reports << new_entry.convert_to_utf8
+            reports << new_entry
           end
         elsif "#{kind}" == "summary"
           def summary(new_entry)
-            summaries << new_entry.convert_to_utf8
+            summaries << new_entry
           end
         else
           def #{kind}(*fields)
             #{kind}s << ( fields.first.is_a?(Hash) ?
-                          fields.first.convert_to_utf8 :
-                          {:subject => fields.first.convert_to_utf8, :body => fields.last.convert_to_utf8} )
+                          fields.first :
+                          {:subject => fields.first, :body => fields.last} )
           end
         end
         alias_method :add_#{kind}, :#{kind}

data/lib/scout/server.rb

@@ -1,14 +1,13 @@
-
 Dir.glob(File.join(File.dirname(__FILE__), *%w[.. .. vendor *])).each do |dir|
   $LOAD_PATH << File.join(dir,"lib")
 end
-
 require "multi_json"
 require "pusher"
 require "httpclient"
 
 module Scout
   class Server < Scout::ServerBase
+    include ThirdPartyPlugins
     # 
     # A plugin cannot take more than DEFAULT_PLUGIN_TIMEOUT seconds to execute, 
     # otherwise, a timeout error is generated.  This can be overriden by
@@ -28,7 +27,7 @@ module Scout
     attr_reader :client_key
 
     # Creates a new Scout Server connection.
-    def initialize(server, client_key, history_file, logger=nil, server_name=nil, http_proxy='', https_proxy='', roles='', hostname=nil, environment='')
+    def initialize(server, client_key, history_file, logger=nil, server_name=nil, http_proxy='', https_proxy='', roles='', hostname=nil, environment='', munin_plugin_path, nrpe_config_file_path)
       @server       = server
       @client_key   = client_key
       @history_file = history_file
@@ -40,6 +39,8 @@ module Scout
       @roles        = roles || ''
       @hostname     = hostname
       @environment  = environment
+      @munin_plugin_path = munin_plugin_path
+      @nrpe_config_file_path = nrpe_config_file_path
       @plugin_plan  = []
       @plugins_with_signature_errors = []
       @directives   = {} # take_snapshots, interval, sleep_interval
@@ -146,8 +147,8 @@ module Scout
 
             @new_plan = true # used in determination if we should checkin this time or not
 
-            # Add local plugins to the plan.
             @plugin_plan += get_local_plugins
+            @plugin_plan += get_third_party_plugins
           rescue Exception =>e
             fatal "Plan from server was malformed: #{e.message} - #{e.backtrace}"
             exit
@@ -157,6 +158,7 @@ module Scout
         info "Plan not modified."
         @plugin_plan = Array(@history["old_plugins"])
         @plugin_plan += get_local_plugins
+        @plugin_plan += get_third_party_plugins
         @directives = @history["directives"] || Hash.new
 
       end
@@ -393,34 +395,40 @@ module Scout
             plugin['origin'] = nil
           end
         end
-        debug "Compiling plugin..."
-        begin
-          eval( code_to_run,
-                TOPLEVEL_BINDING,
-                plugin['path'] || plugin['name'] )
-          info "Plugin compiled."
-        rescue Exception
-          raise if $!.is_a? SystemExit
-          error "Plugin #{plugin['path'] || plugin['name']} would not compile: #{$!.message}"
-          @checkin[:errors] << build_report(plugin,:subject => "Plugin would not compile", :body=>"#{$!.message}\n\n#{$!.backtrace}")
-          return
-        end
+        if !third_party?(plugin)
+          debug "Compiling plugin..."
+          begin
+            eval( code_to_run,
+                  TOPLEVEL_BINDING,
+                  plugin['path'] || plugin['name'] )
+            info "Plugin compiled."
+          rescue Exception
+            raise if $!.is_a? SystemExit
+            error "Plugin #{plugin['path'] || plugin['name']} would not compile: #{$!.message}"
+            @checkin[:errors] << build_report(plugin,:subject => "Plugin would not compile", :body=>"#{$!.message}\n\n#{$!.backtrace}")
+            return
+          end
 
-        # Lookup any local options in plugin_config.properies as needed
-        options=(plugin['options'] || Hash.new)
-        options.each_pair do |k,v|
-          if v=~/^lookup:(.+)$/
-            lookup_key = $1.strip
-            if plugin_config[lookup_key]
-              options[k]=plugin_config[lookup_key]
-            else
-              info "Plugin #{id_and_name}: option #{k} appears to be a lookup, but we can't find #{lookup_key} in #{@plugin_config_path}"
+          # Lookup any local options in plugin_config.properies as needed
+          options=(plugin['options'] || Hash.new)
+          options.each_pair do |k,v|
+            if v=~/^lookup:(.+)$/
+              lookup_key = $1.strip
+              if plugin_config[lookup_key]
+                options[k]=plugin_config[lookup_key]
+              else
+                info "Plugin #{id_and_name}: option #{k} appears to be a lookup, but we can't find #{lookup_key} in #{@plugin_config_path}"
+              end
             end
           end
+        elsif munin?(plugin)
+          Plugin.last_defined = MuninPlugin
+        elsif nagios?(plugin)
+          Plugin.last_defined = NagiosPlugin
         end
 
         debug "Loading plugin..."
-        if job = Plugin.last_defined.load( last_run, (memory || Hash.new), options)
+        if job = third_party?(plugin) ? load_third_party(plugin) : Plugin.last_defined.load( last_run, (memory || Hash.new), options)
           info "Plugin loaded."
           debug "Running plugin..."
           begin
@@ -486,7 +494,8 @@ module Scout
       if Plugin.last_defined
         debug "Removing plugin code..."
         begin
-          Object.send(:remove_const, Plugin.last_defined.to_s.split("::").first)
+          klasses = Plugin.last_defined.to_s.split("::")
+          Object.send(:remove_const, klasses.include?("Scout") ? klasses.last : klasses.first) # munin and nagios plugins have "Scout::Munin/Nagios". don't want to remove 'Scout'.
           Plugin.last_defined = nil
           info "Plugin Removed."
         rescue

data/lib/scout/third_party_plugins/munin_plugin.rb

@@ -0,0 +1,25 @@
+module Scout
+  class MuninPlugin < Scout::Plugin
+    attr_accessor :file_name, :dir
+
+    # The file name of the munin plugin to run inside the munin plugins directory.
+    def initialize(options)
+      self.file_name = options['file_name']
+      self.dir = options['dir']
+    end
+
+    def build_report
+      output = IO.popen("cd #{dir};munin-run #{file_name}").readlines[0..19]
+      data = {}
+      output.each do |l|
+        # "i0.value 724\n"
+        match_data = l.match("^(.*).value\s(.*)$")
+        next if match_data.nil? # "multigraph diskstats_latency\n"
+        name = match_data[1]
+        value = match_data[2].to_f
+        data[name] = value
+      end
+      report(data)
+    end
+  end
+end

data/lib/scout/third_party_plugins/nagios_plugin.rb

@@ -0,0 +1,54 @@
+module Scout
+  class NagiosPlugin < Scout::Plugin
+    attr_accessor :cmd
+
+    # The command, with arguments, to run a nagios plugin.
+    # Ex: /usr/lib/nagios/plugins/check_procs -w 150 -c 200
+    def initialize(cmd)
+      self.cmd = cmd
+    end
+
+    def build_report
+      return if !sanity_check
+
+      # We only support parsing the first line of nagios plugin output
+      IO.popen("#{cmd}") {|io| @nagios_output = io.readlines[0] }
+      
+      # Use exit status integer for OK/WARN/ERROR/CRIT status
+      plugin_status = $?.exitstatus
+
+      data = parse_nagios_output(@nagios_output)
+      report(data.merge({:status => plugin_status}))
+    end
+
+    def sanity_check
+      match = cmd.match(/(\S+)/)
+      file = match[1].to_s
+      if !File.exists?(file)
+        error("The Nagios plugin file does not exist", "The file does not exist: #{file}.")
+      elsif !File.executable?(file)
+        error("Can not execute Nagios plugin", "The file is not executable: #{file}.")
+      end
+      data_for_server[:errors].any? ? false : true
+    end
+
+    def parse_nagios_output(output)
+      text_field, perf_field = output.split('|',2)
+      perf_data = {}
+      if !perf_field.nil? && perf_field.strip!.length
+        # Split the perf field
+        # 1) on spaces
+        # 2) up to the first 10 metrics
+        # 3) split each "k=v;;;;" formatted metric into a key and value
+        # 4) add the key to perf_data, and the digits from the value
+        perf_field.split(" ")[0,10].inject(perf_data) {|r,e| k,v=e.split('=')[0,2]; r[k] = v.slice!(/^[\d.]*/).to_f if k && v; r}
+      end
+
+      #TODO - Allow ability to define regex captures of the text field numerical values as metrics
+      text_data = {}
+
+      return perf_data.merge(text_data)
+    end
+
+  end
+end

data/lib/scout/third_party_plugins/third_party_plugins.rb

@@ -0,0 +1,95 @@
+# Abstracted logic for handling third-party plugins in the +Server+ class.
+module ThirdPartyPlugins
+  # Returns true if the plugin hash is associated w/a 3rd-party plugin like Nagios or Munin.
+  def third_party?(hash)
+    self.munin?(hash) or self.nagios?(hash)
+  end
+
+  def munin?(hash)
+    hash['type'].to_s == 'MUNIN'
+  end
+
+  def nagios?(hash)
+    hash['type'].to_s == 'NAGIOS'
+  end
+
+  # Loading third-party plugins is simplier as they don't have options or memory.
+  def load_third_party(hash)
+  	if munin?(hash)
+  		MuninPlugin.new(hash['file_name'])
+  	elsif nagios?(hash)
+  		Scout::NagiosPlugin.new(hash['cmd'])
+  	end
+  end
+
+  def get_third_party_plugins
+		(get_munin_plugins + get_nagios_plugins).compact
+  end
+
+  def get_munin_plugins
+	  return [] unless @munin_plugin_path
+	  munin_plugin_path=Dir.glob(File.join(@munin_plugin_path,"*"))
+	  munin_plugin_path.map do |plugin_path|
+	    name    = File.basename(plugin_path)
+	    options = if directives = @plugin_plan.find { |plugin| plugin['filename'] == name }
+	                 directives['options']
+	              else 
+	                nil
+	              end
+	    begin
+	      plugin = {
+	        'name'            => name,
+	        'local_filename'  => name,
+	        'origin'          => 'LOCAL',
+	        'type'            => 'MUNIN',
+	        'code'            => name,
+	        'interval'        => 0,
+	        'options'         => options,
+	        'dir'							=> @munin_plugin_path
+	      }
+	      plugin
+	    rescue => e
+	      info "Error trying to read local plugin: #{plugin_path} -- #{e.backtrace.join('\n')}"
+	      nil
+	    end
+  	end.compact
+	end
+
+	def get_nagios_plugins
+	  return [] unless @nrpe_config_file_path
+	  begin
+	  	nrpe_config = File.read(@nrpe_config_file_path)
+	  rescue => e
+	  	info "Unable to read Nagios NRPE Config file [#{@nrpe_config_file_path}]: #{e.message}"
+	  	return []
+	  end
+	  commands = {}
+	  nrpe_config.split("\n").each do |l|
+	    # command[check_total_procs]=/usr/lib/nagios/plugins/check_procs -w 150 -c 200 
+	    # TODO - don't parse commands w/remote args. : command[check_load]=/usr/lib/nagios/plugins/check_load -w $ARG1$ -c $ARG2$
+	    match = l.match(/(^command\[(.*)\]=)(.*)/)
+	    if match  
+	    	if match[3].include?('$ARG')
+	    		info "Skipping Nagios Command [#{match[2]}] as it contains remote arguments."
+	    	else
+	      	commands[match[2]] = match[3]
+	      end
+	    end
+	  end
+	  debug "Found #{commands.size} Nagios plugins"
+	  # todo - ensure cmd file exists
+	  plugins = []
+	  commands.each do |name,cmd|
+	    plugins << {
+	      'name'            => name,
+	      'local_filename'  => name,
+	      'origin'          => 'LOCAL',
+	      'type'            => 'NAGIOS',
+	      'code'            => name,
+	      'interval'        => 0,
+	      'cmd'							=> cmd # unique for nagios
+	    }
+	  end
+		 plugins
+	end
+end # ThirdPartyPlugins

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.9.7.2.pre"
+  VERSION = "5.9.8.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout
 version: !ruby/object:Gem::Version
-  version: 5.9.7.2.pre
+  version: 5.9.8.pre
 platform: ruby
 authors:
 - Andre Lewis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elif
@@ -70,7 +70,6 @@ files:
 - lib/scout/daemon_spawn.rb
 - lib/scout/data_file.rb
 - lib/scout/environment.rb
-- lib/scout/helpers.rb
 - lib/scout/http.rb
 - lib/scout/plugin.rb
 - lib/scout/plugin_options.rb
@@ -79,6 +78,9 @@ files:
 - lib/scout/server_base.rb
 - lib/scout/streamer.rb
 - lib/scout/streamer_daemon.rb
+- lib/scout/third_party_plugins/munin_plugin.rb
+- lib/scout/third_party_plugins/nagios_plugin.rb
+- lib/scout/third_party_plugins/third_party_plugins.rb
 - lib/scout/version.rb
 - scout.gemspec
 - test/plugins/disk_usage.rb
@@ -338,4 +340,8 @@ specification_version: 4
 summary: Scout is an easy-to-use hosted server monitoring service. The scout Ruby
   gem reports metrics to our service. The agent runs plugins, configured via the Scout
   web interface, to monitor a server.
-test_files: []
+test_files:
+- test/plugins/disk_usage.rb
+- test/scout_test.rb
+- test/streamer_test.rb
+has_rdoc: 

data/lib/scout/helpers.rb

@@ -1,21 +0,0 @@
-class Hash
-  def convert_to_utf8
-    result_hash = {}
-    self.each do |k,v|
-      new_key = k.respond_to?(:convert_to_utf8) ? k.convert_to_utf8 : k
-      new_value = v.respond_to?(:convert_to_utf8) ? v.convert_to_utf8 : v
-      result_hash[new_key] = new_value
-    end
-    return result_hash
-  end
-end
-
-class String
-  def convert_to_utf8
-    if self.respond_to?('encode') # We can convert natively using Ruby >1.9 encode()
-      return self.encode('UTF-8', {:invalid => :replace, :undef => :replace, :replace => '?'})
-    else # We can't convert natively, do nothing.
-      return self
-    end
-  end
-end