sensu-plugins-graphite 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbaa30251f9a811b2deca986adc4c2dd5dc9f8a8
-  data.tar.gz: 9fbf4668de0abe92b0878b17291a14155ce5231e
+  metadata.gz: 95919766647d9a11674c461481f6bf721f6dd5c7
+  data.tar.gz: 73c6e2979abaa4ff35f69b510000e96410921e6d
 SHA512:
-  metadata.gz: 7bb8ebed40fc8e765d695124252722984d34df5e3e13f82565917baf2ef2837f6207e2066c46274b6105504b0cbb0f86bab13668f4b852846477a5b865914422
-  data.tar.gz: c55a249ca72638935d3323432c78d606f27c2ef0a5a5982a53fb836e6d522c5d86534e802bea954d5f058cc61760694c76cd387dc68c01fb027808e1e6f2570d
+  metadata.gz: efcbdf877c3405cd8a7b98756581945f6d547b3c41942d61c1ea78dfe7deed82de5eb6dd1ade93d1745b371d981c69cba262ea4cf194a464870a74ebf769b227
+  data.tar.gz: a75f1d56bb46334dcd4a32147f1644311b0ea78c43b832ac015eb86d76259c08b2a2587eac3f38a038c4959544f214a8eec27a2c0b4522247339c5ef112e0c65

data/CHANGELOG.md

@@ -4,7 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
-- nothing
+
+## [0.0.6] - 2015-08-27
+### Added
+- check on number of hosts
+- -auth param allows authentication by bearer token
 
 ## [0.0.5] - 2015-08-05
 ### Changed
@@ -28,7 +32,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[unreleased]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.5...HEAD
+[unreleased]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.6...HEAD
+[0.0.6]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.5...0.0.6
 [0.0.5]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.4...0.0.5
 [0.0.4]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.3...0.0.4
 [0.0.3]: https://github.com/sensu-plugins/sensu-plugins-graphite/compare/0.0.2...0.0.3

data/bin/check-graphite-data.rb

@@ -31,48 +31,11 @@ require 'json'
 require 'open-uri'
 require 'openssl'
 
+require 'sensu-plugins-graphite/graphite_proxy/options'
+require 'sensu-plugins-graphite/graphite_proxy/proxy'
+
 class CheckGraphiteData < Sensu::Plugin::Check::CLI
-  option :target,
-         description: 'Graphite data target',
-         short: '-t TARGET',
-         long: '--target TARGET',
-         required: true
-
-  option :server,
-         description: 'Server host and port',
-         short: '-s SERVER:PORT',
-         long: '--server SERVER:PORT',
-         required: true
-
-  option :username,
-         description: 'username for basic http authentication',
-         short: '-u USERNAME',
-         long: '--user USERNAME',
-         required: false
-
-  option :password,
-         description: 'user password for basic http authentication',
-         short: '-p PASSWORD',
-         long: '--pass PASSWORD',
-         required: false
-
-  option :passfile,
-         description: 'password file path for basic http authentication',
-         short: '-P PASSWORDFILE',
-         long: '--passfile PASSWORDFILE',
-         required: false
-
-  option :warning,
-         description: 'Generate warning if given value is above received value',
-         short: '-w VALUE',
-         long: '--warn VALUE',
-         proc: proc(&:to_f)
-
-  option :critical,
-         description: 'Generate critical if given value is above received value',
-         short: '-c VALUE',
-         long: '--critical VALUE',
-         proc: proc(&:to_f)
+  include SensuPluginsGraphite::GraphiteProxy::Options
 
   option :reset_on_decrease,
          description: 'Send OK if value has decreased on any values within END-INTERVAL to END',
@@ -80,12 +43,6 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
          long: '--reset INTERVAL',
          proc: proc(&:to_i)
 
-  option :name,
-         description: 'Name used in responses',
-         short: '-n NAME',
-         long: '--name NAME',
-         default: 'graphite check'
-
   option :allowed_graphite_age,
          description: 'Allowed number of seconds since last data update (default: 60 seconds)',
          short: '-a SECONDS',
@@ -93,32 +50,6 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
          default: 60,
          proc: proc(&:to_i)
 
-  option :hostname_sub,
-         description: 'Character used to replace periods (.) in hostname (default: _)',
-         short: '-s CHARACTER',
-         long: '--host-sub CHARACTER'
-
-  option :from,
-         description: 'Get samples starting from FROM (default: -10mins)',
-         short: '-f FROM',
-         long: '--from FROM',
-         default: '-10mins'
-
-  option :below,
-         description: 'warnings/critical if values below specified thresholds',
-         short: '-b',
-         long: '--below'
-
-  option :no_ssl_verify,
-         description: 'Do not verify SSL certs',
-         short: '-v',
-         long: '--nosslverify'
-
-  option :help,
-         description: 'Show this message',
-         short: '-h',
-         long: '--help'
-
   # Run checks
   def run
     if config[:help]
@@ -126,13 +57,19 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
       exit
     end
 
-    data = retrieve_data
-    data.each_pair do |_key, value|
-      @value = value
-      @data = value['data']
-      check_age || check(:critical) || check(:warning)
+    proxy = SensuPluginsGraphite::GraphiteProxy::Proxy.new(config)
+    begin
+      results = proxy.retrieve_data!
+      results.each_pair do |_key, value|
+        @value = value
+        @data = value['data']
+        check_age || check(:critical) || check(:warning)
+      end
+
+      ok("#{name} value okay")
+    rescue SensuPluginsGraphite::GraphiteProxy::ProxyError => e
+      unknown e.message
     end
-    ok("#{name} value okay")
   end
 
   # name used in responses
@@ -143,16 +80,14 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
 
   # Check the age of the data being processed
   def check_age
-    # #YELLOW
-    if (Time.now.to_i - @value['end']) > config[:allowed_graphite_age] # rubocop:disable GuardClause
+    if (Time.now.to_i - @value['end']) > config[:allowed_graphite_age]
       unknown "Graphite data age is past allowed threshold (#{config[:allowed_graphite_age]} seconds)"
     end
   end
 
   # grab data from graphite
   def retrieve_data
-    # #YELLOW
-    unless @raw_data # rubocop:disable GuardClause
+    unless @raw_data
       begin
         unless config[:server].start_with?('https://', 'http://')
           config[:server].prepend('http://')
@@ -215,8 +150,7 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
   # type:: :warning or :critical
   # Return alert if required
   def check(type)
-    # #YELLOW
-    if config[type] # rubocop:disable GuardClause
+    if config[type]
       send(type, "#{@value['target']} has passed #{type} threshold (#{@data.last})") if below?(type) || above?(type)
     end
   end
@@ -241,15 +175,4 @@ class CheckGraphiteData < Sensu::Plugin::Check::CLI
       false
     end
   end
-
-  # Returns formatted target with hostname replacing any $ characters
-  def formatted_target
-    if config[:target].include?('$')
-      require 'socket'
-      @formatted = Socket.gethostbyname(Socket.gethostname).first.gsub('.', config[:hostname_sub] || '_')
-      config[:target].gsub('$', @formatted)
-    else
-      URI.escape config[:target]
-    end
-  end
 end

data/bin/check-graphite-hosts.rb

@@ -0,0 +1,98 @@
+#! /usr/bin/env ruby
+#
+#   check-graphite-hosts
+#
+# DESCRIPTION:
+#   This plugin checks the number of hosts within graphite that are sending
+#   data, and alerts if it is below a given threshold
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: openssl
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2014 Sonian, Inc. and contributors. <support@sensuapp.org>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'open-uri'
+require 'openssl'
+
+require 'sensu-plugins-graphite/graphite_proxy/options'
+require 'sensu-plugins-graphite/graphite_proxy/proxy'
+
+class CheckGraphiteHosts < Sensu::Plugin::Check::CLI
+  include SensuPluginsGraphite::GraphiteProxy::Options
+
+  # Run checks
+  def run
+    if config[:help]
+      puts opt_parser if config[:help]
+      exit
+    end
+
+    proxy = SensuPluginsGraphite::GraphiteProxy::Proxy.new(config)
+    begin
+      results = proxy.retrieve_data!
+
+      check(:critical, results) || check(:warning, results)
+      ok("#{name} value (#{hosts_with_data(results)}) okay")
+    rescue SensuPluginsGraphite::GraphiteProxy::ProxyError => e
+      unknown e.message
+    end
+  end
+
+  # name used in responses
+  def name
+    base = config[:name]
+    @formatted ? "#{base} (#{@formatted})" : base
+  end
+
+  # return the number of hosts with data in the given set of results
+  def hosts_with_data(resultset)
+    resultset.count { |_host, values| !values['data'].empty? }
+  end
+
+  # type:: :warning or :critical
+  # Return alert if required
+  def check(type, results)
+    # #YELLOW
+    num_hosts = hosts_with_data(results)
+    return unless config[type] && threshold_crossed?(type, num_hosts)
+
+    msg = hosts_threshold_message(config[:target], num_hosts, type)
+    send(type, msg)
+  end
+
+  def threshold_crossed?(type, num_hosts)
+    below?(type, num_hosts) || above?(type, num_hosts)
+  end
+
+  def hosts_threshold_message(target, hosts, type)
+    "Number of hosts sending #{target} (#{hosts}) has passed #{type} threshold (#{config[type]})"
+  end
+
+  # Check if value is below defined threshold
+  def below?(type, val)
+    config[:below] && val < config[type]
+  end
+
+  # Check is value is above defined threshold
+  def above?(type, val)
+    (!config[:below]) && (val > config[type])
+  end
+end

data/bin/check-graphite.rb

@@ -148,7 +148,7 @@ class Graphite < Sensu::Plugin::Check::CLI
 
   def graphite_cache(target = nil)
     # #YELLOW
-    if @graphite_cache.key?(target) # rubocop:disable GuardClause
+    if @graphite_cache.key?(target)
       graphite_value = @graphite_cache[target].select { |value| value[:period] == @period }
       graphite_value if graphite_value.size > 0
     end
@@ -199,8 +199,6 @@ class Graphite < Sensu::Plugin::Check::CLI
     if data.size > 0
       data.each { |d| @graphite_cache[target] << { target: d['target'], period: @period, datapoints: d['datapoints'] } }
       graphite_cache target
-    else # rubocop:disable all
-      nil
     end
   end
 
@@ -220,8 +218,6 @@ class Graphite < Sensu::Plugin::Check::CLI
   def get_max_value(values)
     if values
       values.map { |i| i[0] ? i[0] : 0 }[0..-2].max
-    else # rubocop:disable all
-      nil
     end
   end
 
@@ -249,8 +245,6 @@ class Graphite < Sensu::Plugin::Check::CLI
         ret.push(values[values_size]) if values[values_size][0]
       end
       ret
-    else # rubocop:disable all
-      nil
     end
   end
 
@@ -291,7 +285,7 @@ class Graphite < Sensu::Plugin::Check::CLI
     last_gv = last_graphite_value target
     if last_gv.is_a?(Hash) && max_gv.is_a?(Hash)
       # #YELLOW
-      last_gv.each do |target_name, value| # rubocop:disable Style/Next
+      last_gv.each do |target_name, value|
         if value && max_gv[target_name]
           last = value
           max = max_gv[target_name]
@@ -326,7 +320,7 @@ class Graphite < Sensu::Plugin::Check::CLI
       last_value = last_values[target]
       percent = last_value / avg_value unless last_value.nil? || avg_value.nil?
       # #YELLOW
-      %w(fatal error warning).each do |type|  # rubocop:disable Style/Next
+      %w(fatal error warning).each do |type|
         next unless max_values.key?(type)
         max_value = max_values[type]
         var1 = config[:greater_than] ? percent : max_value.to_f
@@ -363,7 +357,7 @@ class Graphite < Sensu::Plugin::Check::CLI
       # #YELLOW
       avg_value = values_array.reduce { |sum, el| sum + el if el }.to_f / values_array.size # rubocop:disable SingleLineBlockParams
       # YELLOW
-      %w(fatal error warning).each do |type|  # rubocop:disable Style/Next
+      %w(fatal error warning).each do |type|
         next unless max_values.key?(type)
         max_value = max_values[type]
         var1 = config[:greater_than] ? avg_value : max_value.to_f
@@ -402,7 +396,7 @@ class Graphite < Sensu::Plugin::Check::CLI
       last_value = last_values[target]
       percent = last_value / percentile_value unless last_value.nil? || percentile_value.nil?
       # #YELLOW
-      %w(fatal error warning).each do |type|  # rubocop:disable Style/Next
+      %w(fatal error warning).each do |type|
         next unless max_values.key?(type)
         max_value = max_values[type]
         var1 = config[:greater_than] ? percent : max_value.to_f
@@ -434,11 +428,11 @@ class Graphite < Sensu::Plugin::Check::CLI
     criticals = []
     fatal = []
     # #YELLOW
-    last_targets.each do |target_name, last|   # rubocop:disable Style/Next
+    last_targets.each do |target_name, last|
       last_value = last.first
       unless last_value.nil?
         # #YELLOW
-        %w(fatal error warning).each do |type|   # rubocop:disable Style/Next
+        %w(fatal error warning).each do |type|
           next unless max_values.key?(type)
           max_value = max_values[type]
           var1 = config[:greater_than] ? last_value : max_value.to_f
@@ -463,14 +457,14 @@ class Graphite < Sensu::Plugin::Check::CLI
     [warnings, criticals, fatal]
   end
 
-  def run # rubocop:disable all
+  def run
     targets = config[:target].split(',')
     @period = config[:period]
     critical_errors = []
     warnings = []
     fatals = []
     # #YELLOW
-    targets.each do |target|   # rubocop:disable Style/Next
+    targets.each do |target|
       if config[:check_function_increasing]
         inc_warnings, inc_critical, inc_fatal = check_increasing target
         warnings += inc_warnings

data/lib/sensu-plugins-graphite/graphite_proxy/options.rb

@@ -0,0 +1,113 @@
+module SensuPluginsGraphite
+  module GraphiteProxy
+    module Options
+      def self.included(base)
+        add_default_options(base)
+      end
+
+      def self.add_default_options(base)
+        default_options.each do |name, vals|
+          base.send(:option, name, vals)
+        end
+      end
+
+      def self.default_options
+        {
+          target: {
+            description: 'Graphite data target',
+            short: '-t TARGET',
+            long: '--target TARGET',
+            required: true
+          },
+
+          server: {
+            description: 'Server host and port',
+            short: '-s SERVER:PORT',
+            long: '--server SERVER:PORT',
+            required: true
+          },
+
+          username: {
+            description: 'username for basic http authentication',
+            short: '-u USERNAME',
+            long: '--user USERNAME',
+            required: false
+          },
+
+          password: {
+            description: 'user password for basic http authentication',
+            short: '-p PASSWORD',
+            long: '--pass PASSWORD',
+            required: false
+          },
+
+          passfile: {
+            description: 'password file path for basic http authentication',
+            short: '-P PASSWORDFILE',
+            long: '--passfile PASSWORDFILE',
+            required: false
+          },
+
+          no_ssl_verify: {
+            description: 'Do not verify SSL certs',
+            short: '-v',
+            long: '--nosslverify'
+          },
+
+          help: {
+            description: 'Show this message',
+            short: '-h',
+            long: '--help'
+          },
+
+          auth: {
+            description: 'Add an auth token to the HTTP request, in the form of "Name: Value",
+                                             e.g. --auth yourapitokenvaluegoeshere',
+            short: '-a TOKEN',
+            long: '--auth TOKEN'
+          },
+
+          name: {
+            description: 'Name used in responses',
+            short: '-n NAME',
+            long: '--name NAME',
+            default: 'graphite check'
+          },
+
+          hostname_sub: {
+            description: 'Character used to replace periods (.) in hostname (default: _)',
+            short: '-s CHARACTER',
+            long: '--host-sub CHARACTER'
+          },
+
+          from: {
+            description: 'Get samples starting from FROM (default: -10mins)',
+            short: '-f FROM',
+            long: '--from FROM',
+            default: '-10mins'
+          },
+
+          warning: {
+            description: 'Generate warning if number of hosts is below received value',
+            short: '-w VALUE',
+            long: '--warn VALUE',
+            proc: proc(&:to_f)
+          },
+
+          critical: {
+            description: 'Generate critical if number of hosts is below received value',
+            short: '-c VALUE',
+            long: '--critical VALUE',
+            proc: proc(&:to_f)
+          },
+
+          below: {
+            description: 'alert if number of hosts below specified thresholds',
+            short: '-b',
+            long: '--below'
+          }
+        }
+      end
+    end
+  end
+end

data/lib/sensu-plugins-graphite/graphite_proxy/proxy.rb

@@ -0,0 +1,113 @@
+require 'open-uri'
+
+module SensuPluginsGraphite
+  module GraphiteProxy
+    class ProxyError < StandardError
+      attr_accessor :exception
+
+      def initialize(msg, args)
+        self.exception = args[:exception]
+        super msg
+      end
+    end
+
+    class Proxy
+      attr_accessor :config
+
+      def initialize(config)
+        self.config = config
+      end
+
+      def formatted_target
+        if config[:target].include?('$')
+          require 'socket'
+          formatted = Socket.gethostbyname(Socket.gethostname).first.gsub('.', config[:hostname_sub] || '_')
+          config[:target].gsub('$', formatted)
+        else
+          URI.escape config[:target]
+        end
+      end
+
+      def request_auth_options(given_opts)
+        url_opts = {}
+
+        url_opts[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE if given_opts[:no_ssl_verify]
+
+        if given_opts[:username]
+          pass = derive_password(given_opts)
+          url_opts[:http_basic_authentication] = [given_opts[:username], pass.chomp]
+        end # we don't have both username and password trying without
+
+        url_opts['Authorization'] = "Bearer #{given_opts[:auth]}" if given_opts[:auth]
+
+        url_opts
+      end
+
+      def derive_password(given_opts)
+        if given_opts[:passfile]
+          File.open(given_opts[:passfile]).readline
+        elsif given_opts[:password]
+          given_opts[:password]
+        end
+      end
+
+      def format_output(data)
+        output = {}
+
+        data.each do |raw|
+          unless raw['datapoints'].empty?
+            line = output_line(raw)
+            output[line['target']] = line
+          end
+        end
+        output
+      end
+
+      def output_line(raw)
+        raw['datapoints'].delete_if { |v| v.first.nil? }
+        target = raw['target']
+        data = raw['datapoints'].map(&:first)
+        start = raw['datapoints'].first.last
+        dend = raw['datapoints'].last.last
+        step = ((dend - start) / raw['datapoints'].size.to_f).ceil
+
+        { 'target' => target, 'data' => data, 'start' => start, 'end' => dend, 'step' => step }
+      end
+
+      # grab data from graphite
+      def retrieve_data!
+        unless @raw_data
+          begin
+            unless config[:server].start_with?('https://', 'http://')
+              config[:server].prepend('http://')
+            end
+
+            url = "#{config[:server]}/render?format=json&target=#{formatted_target}&from=#{config[:from]}"
+
+            handle = open(url, request_auth_options(config))
+
+            @raw_data = handle.gets
+            if @raw_data == '[]'
+              unknown 'Empty data received from Graphite - metric probably doesn\'t exists'
+            else
+              json_data = JSON.parse(@raw_data)
+              format_output(json_data)
+            end
+          rescue OpenURI::HTTPError => e
+            raise ProxyError.new('Failed to connect to graphite server', exception: e)
+          rescue NoMethodError => e
+            raise ProxyError.new('No data for time period and/or target', exception: e)
+          rescue Errno::ECONNREFUSED => e
+            raise ProxyError.new('Connection refused when connecting to graphite server', exception: e)
+          rescue Errno::ECONNRESET => e
+            raise ProxyError.new('Connection reset by peer when connecting to graphite server', exception: e)
+          rescue EOFError => e
+            raise ProxyError.new('End of file error when reading from graphite server', exception: e)
+          rescue => e
+            raise ProxyError.new("An unknown error occured: #{e.inspect}", exception: e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-graphite/version.rb

@@ -2,7 +2,7 @@ module SensuPluginsGraphite
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 5
+    PATCH = 6
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-graphite
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sensu Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_stats
@@ -241,6 +241,7 @@ executables:
 - check-graphite.rb
 - check-graphite-stats.rb
 - check-graphite-replication.rb
+- check-graphite-hosts.rb
 - check-graphite-data.rb
 extensions: []
 extra_rdoc_files: []
@@ -249,6 +250,7 @@ files:
 - LICENSE
 - README.md
 - bin/check-graphite-data.rb
+- bin/check-graphite-hosts.rb
 - bin/check-graphite-replication.rb
 - bin/check-graphite-stats.rb
 - bin/check-graphite.rb
@@ -257,6 +259,8 @@ files:
 - bin/handler-graphite-occurrences.rb
 - bin/mutator-graphite.rb
 - lib/sensu-plugins-graphite.rb
+- lib/sensu-plugins-graphite/graphite_proxy/options.rb
+- lib/sensu-plugins-graphite/graphite_proxy/proxy.rb
 - lib/sensu-plugins-graphite/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-graphite
 licenses: