sensu-plugins-influxdb-q 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2289304a9e9317ebe88e5c9f8675cb0a8749cf9f
-  data.tar.gz: 44aae20b6adc5ee9e58b1e6344e12bf8fab8c522
+  metadata.gz: 0d24cae40e61200c0f3fbc7007498f0a3eedaf04
+  data.tar.gz: 4c611a05196d5f388fb03f5dbb467d57b3f4893b
 SHA512:
-  metadata.gz: 03ad4e0226f543b3d2b072a5b0fdb23e50c25a065818ed98de8146d835634cfe2c2dc248d8076efbcac8a1744d6648a34f1c40eb8560272259487a239f26f147
-  data.tar.gz: 946ea02f53b7f5c9f92ffcb8111afc3558c3b8cd3a89f8940d98223a5b405059abcc936e17e1719e96bccbec60e0e7d3fa9dd432c2689bd3987b139a9443d5a5
+  metadata.gz: 6ecd6223a8bdb04a03a4ef6f428c371b421fab02dc172b39f14694c8d03f66f016ed23ff69b2acd850d1a3afad5fcad1f4d08d4dfa35ab4584218650023c111e
+  data.tar.gz: afeca730f93429da2ae027ee0b521ea4dbeb06ed75ce197b7ff0bc2b2bfab5df5d8fe52c3bf1e09c59fa361017b14e1851ce23cbd0dc81f8c31cad54078d16bc

data/CHANGELOG.md

@@ -3,6 +3,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
+## [0.0.8] - 2016-01-18
+### Added
+- Not filtering by sensu clients anymore
+
 ## [0.0.7] - 2016-01-18
 ### Added
 - Fixing closing bracket

data/README.md

@@ -4,9 +4,9 @@ A sensu plugin that extends Sensu with the ability to run queries against Influx
 
 This is generally useful when you have to evaluate an issue using some analytics functions (e.g. moving average, derivative etc.).
 
-The plugin discovers all active sensu clients via the Sensu REST API and then runs for each client the InfluxDB query filtering by host.
-The plugin then generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input),
-making sure to override the client source (in the check result) so that the check shows up as if it was triggered by the original sensu client.
+The plugin generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input),
+making sure to override the client source (in the check result) so that the check shows up as if it was triggered by the original sensu client. The client
+source is overriden ONLY if the host field (--host-field) is present in the results returned by the InfluxDB query.
 
 The plugin is inspired by https://github.com/sensu-plugins/sensu-plugins-influxdb.
 
@@ -20,13 +20,14 @@ Usage: check-influxdb-q.rb (options)
     -c, --crit <EXPR>                Critical expression (e.g. value >= 10)
         --database <DATABASE>        InfluxDB database (default: collectd)
         --dryrun                     Do not send events to sensu client socket
-        --handlers <HANDLERS>        Comma separated list of handlers
+        --handlers <HANDLER>         Comma separated list of handlers
         --host <HOST>                InfluxDB host (default: localhost)
         --host-field <FIELD>         InfluxDB measurement host field (default: host)
     -j, --json-path <PATH>           JSON path for value matching (docs at http://goessner.net/articles/JsonPath)
     -m, --msg <MESSAGE>              Message to use for OK/WARNING/CRITICAL, supports variable interpolation (e.g. %{tags.instance}) (required)
         --port <PORT>                InfluxDB port (default: 8086)
-    -q, --query <QUERY>              Query to execute [e.g. SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), instance, type fill(none)] (required)
+    -q, --query <QUERY>              Query to execute [e.g. SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), host, instance, type fill(none)] (required)
+        --timeout <SECONDS>          InfluxDB query timeout (default: 3)
         --use-ssl                    InfluxDB SSL (default: false)
     -w, --warn <EXPR>                Warning expression (e.g. value >= 5)
 ```
@@ -39,7 +40,7 @@ A typical example could be the monitoring of interface errors when using the 'in
 
 
 ```
-check-influxdb-q.rb -q "SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), instance, type fill(none)" -j '$.values[-1].value' -w 'value > 0' --msg "Number of RX errors on interface %{tags.instance}"
+check-influxdb-q.rb -q "SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), host, instance, type fill(none)" -j '$.values[-1].value' -w 'value > 0' --msg "Number of RX errors on interface %{tags.instance}"
 ```
 
 An handy feature is the ability to interpolate the query result hash attributes into the --check-name and --msg command line flags.

data/bin/check-influxdb-q.rb

@@ -37,7 +37,7 @@ class CheckInfluxDbQ < Sensu::Plugin::Check::CLI
   include Sensu::Plugin::Utils
 
   option :query,
-         :description => "Query to execute [e.g. SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), instance, type fill(none)]",
+         :description => "Query to execute [e.g. SELECT DERIVATIVE(LAST(value), 1m) AS value FROM interface_rx WHERE type = 'if_errors' AND time > now() - 5m group by time(1m), host, instance, type fill(none)]",
          :short => "-q <QUERY>",
          :long => "--query <QUERY>",
          :required => true
@@ -92,6 +92,12 @@ class CheckInfluxDbQ < Sensu::Plugin::Check::CLI
          :long => "--host-field <FIELD>",
          :default => "host"
 
+  option :only_sensu_clients,
+         :description => "Only consider measurements of known sensu clients",
+         :long => "--only-sensu-clients",
+         :boolean => true
+         :default => false
+
   option :handlers,
          :description => "Comma separated list of handlers",
          :long => "--handlers <HANDLER>",
@@ -201,13 +207,21 @@ class CheckInfluxDbQ < Sensu::Plugin::Check::CLI
   def run()
     problems = 0
 
-    @clients.each do |client|
-      query = config[:query].gsub(" WHERE ", " WHERE #{config[:host_field]} = '#{client}' AND ")
-      begin
-        timeout(config[:timeout]) do
-          begin
-            records = @influxdb.query(query)
+    begin
+      timeout(config[:timeout]) do
+        begin
+          records = @influxdb.query(query)
+          if records.size > 0
             records.each do |record|
+              if record.has_key?(config[:host_field])
+                client = record[config[:host_field]]
+
+                # skip client if it's not already known by Sensu
+                next if config[:only_sensu_clients] and ! @clients.include?(client)
+              else
+                client = nil
+              end
+
               if @json_path
                 value = @json_path.on(record).first
 
@@ -233,23 +247,17 @@ class CheckInfluxDbQ < Sensu::Plugin::Check::CLI
                 puts
               end
             end
-          rescue
-            STDERR.puts($!)
-            problems += 1
+          else
+            unknown("InfluxDB query [#{query}] held no results")
           end
+        rescue
+          critical("InfluxDB query [#{query}] failed - (#{$!})")
         end
-      rescue Timeout::Error
-        STDERR.puts("InfluxDB query [#{query}] timed out")
-        problems += 1
       end
+    rescue Timeout::Error
+      unknown("InfluxDB query [#{query}] timed out")
     end
 
-    if problems > 0
-      message("Failed to run query for #{problems} clients")
-      critical if config[:crit]
-      warning
-    else
-      ok("Query executed successfully for #{@clients.size} clients")
-    end
+    ok("Query executed successfully")
   end
 end

data/lib/sensu-plugins-influxdb-q/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-influxdb-q
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Matteo Cerutti