sensu-plugins-influxdb-q 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 204941a95c0a3db4f5cb7813379e21286d713ea0
+  data.tar.gz: 3d6258e8b813733bd458df70c6013f1442315553
+SHA512:
+  metadata.gz: 931e1310fbedad9d6eb5b2e97da449a97161f2b334c312281405e30442cc7c9cc9116ffd13ae985b001a65fefd0d4b487c2f285d8c12be5c706450ca50a7affe
+  data.tar.gz: 810408932d59d1ee8dd0ce0bd77b378cd128df0164b9df836bdaae821e389bf289f4d280c4b2d9ac0d5a0ed632170a40cd9b91769c7252807e33df3315cff630

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased
+
+## [0.0.1] - 2016-01-07
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,54 @@
+# Sensu plugin for running InfluxDB queries
+
+A sensu plugin that extends Sensu with the ability to run queries against InfluxDB.
+
+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 is inspired by https://github.com/sensu-plugins/sensu-plugins-influxdb.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-influxdb-q.rb (options)
+        --check-name <CHECK_NAME>    Check name (default: %{name}-%{tags.instance}-%{tags.type})
+    -c, --crit <EXPR>                Critical expression (e.g. value >= 10)
+        --database <DATABASE>        InfluxDB database (default: collectd)
+        --debug                      Enable debug mode
+        --dryrun                     Do not send events to sensu client socket
+        --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) (required)
+    -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)
+        --use-ssl                    InfluxDB SSL (default: false)
+    -w, --warn <EXPR>                Warning expression (e.g. value >= 5)
+```
+
+## Example
+
+A typical example could be the monitoring of interface errors when using the 'interface' collectd plugin.
+
+
+```
+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 errors on interface %{instance} - %{name}"
+```
+
+An handy feature is the ability to interpolate the query result hash attributes into the --check-name and --msg command line flags.
+
+So, for query above the result might look like the following (run with --debug to inspect the result):
+
+```
+{"name"=>"interface_rx", "tags"=>{"instance"=>"ens255f0", "type"=>"if_errors"}, "values"=>[{"time"=>"2016-01-07T21:43:00Z", "value"=>0}, {"time"=>"2016-01-07T21:44:00Z", "value"=>0}, {"time"=>"2016-01-07T21:45:00Z", "value"=>0}, {"time"=>"2016-01-07T21:46:00Z", "value"=>0}, {"time"=>"2016-01-07T21:47:00Z", "value"=>0}]}
+```
+
+In this case, you can interpolate the following variables: %{name}, %{tags.instance}, %{tags.type}, %{values.0.value} ..
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-influxdb-q.rb

@@ -0,0 +1,234 @@
+#!/usr/bin/env ruby
+#
+# check-influxdb-q.rb
+#
+# Inspired by: https://github.com/sensu-plugins/sensu-plugins-influxdb/blob/master/bin/check-influxdb.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'net/http'
+require 'json'
+require 'sensu-plugin/utils'
+require 'sensu-plugin/check/cli'
+require 'influxdb'
+require 'jsonpath'
+require 'dentaku'
+
+class Hash
+  def symbolize_recursive
+    {}.tap do |h|
+      self.each do |key, value|
+      h[key.to_sym] = case value
+          when Hash
+            value.symbolize_recursive
+          when Array
+            value.map { |v| v.symbolize_recursive }
+          else
+            value
+        end
+      end
+    end
+  end
+end
+
+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)]",
+         :short => "-q <QUERY>",
+         :long => "--query <QUERY>",
+         :required => true
+
+  option :json_path,
+         :description => "JSON path for value matching (docs at http://goessner.net/articles/JsonPath)",
+         :short => "-j <PATH>",
+         :long => "--json-path <PATH>",
+         :required => true
+
+  option :check_name,
+         :description => "Check name (default: %{name}-%{tags.instance}-%{tags.type})",
+         :long => "--check-name <CHECK_NAME>",
+         :default => "%{name}-%{tags.instance}-%{tags.type}"
+
+  option :msg,
+         :description => "Message to use for OK/WARNING/CRITICAL, supports variable interpolation (e.g. %{tags.instance})",
+         :short => "-m <MESSAGE>",
+         :long => "--msg <MESSAGE>",
+         :required => true
+
+  option :database,
+         :description => "InfluxDB database (default: collectd)",
+         :long => "--database <DATABASE>",
+         :default => "collectd"
+
+  option :host,
+         :description => "InfluxDB host (default: localhost)",
+         :long => "--host <HOST>",
+         :default => "localhost"
+
+  option :port,
+         :description => "InfluxDB port (default: 8086)",
+         :long => "--port <PORT>",
+         :proc => proc { |i| i.to_i },
+         :default => 8086
+
+  option :use_ssl,
+         :description => "InfluxDB SSL (default: false)",
+         :long => "--use-ssl",
+         :default => false,
+         :boolean => true
+
+  option :host_field,
+         :description => "InfluxDB measurement host field (default: host)",
+         :long => "--host-field <FIELD>",
+         :default => "host"
+
+  option :warn,
+         :description => "Warning expression (e.g. value >= 5)",
+         :short => "-w <EXPR>",
+         :long => "--warn <EXPR>",
+         :default => nil
+
+  option :crit,
+         :description => "Critical expression (e.g. value >= 10)",
+         :short => "-c <EXPR>",
+         :long => "--crit <EXPR>",
+         :default => nil
+
+  option :debug,
+         :description => "Enable debug mode",
+         :long => "--debug",
+         :boolean => true,
+         :default => false
+
+  option :dryrun,
+         :description => "Do not send events to sensu client socket",
+         :long => "--dryrun",
+         :boolean => true,
+         :default => false
+
+  def initialize()
+    super
+
+    cfg = {
+      :database => config[:database],
+      :host => config[:host],
+      :port => config[:port],
+      :use_ssl => config[:use_ssl]
+    }
+
+    @calculator = Dentaku::Calculator.new
+    @json_path = JsonPath.new(config[:json_path])
+    @influxdb = InfluxDB::Client.new(cfg)
+
+    # get list of hosts
+    @clients = get_clients()
+  end
+
+  def send_client_socket(data)
+    if config[:dryrun]
+      puts data.inspect
+    else
+      sock = UDPSocket.new
+      sock.send(data + "\n", 0, "127.0.0.1", 3030)
+    end
+  end
+
+  def send_ok(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 0, "output" => "OK: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 1, "output" => "WARNING: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 2, "output" => "CRITICAL: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 3, "output" => "UNKNOWN: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def api_request(method, path, &blk)
+    if not settings.has_key?('api')
+      raise "api.json settings not found."
+    end
+    http = Net::HTTP.new(settings['api']['host'], settings['api']['port'])
+    req = net_http_req_class(method).new(path)
+    if settings['api']['user'] && settings['api']['password']
+      req.basic_auth(settings['api']['user'], settings['api']['password'])
+    end
+    yield(req) if block_given?
+    http.request(req)
+  end
+
+  def interpolate(string, hash)
+    string.gsub(/%\{([^\}]*)\}/).each { |match| match[/^%{(.*)}$/, 1].split('.').inject(hash) { |h, k| h[(k.to_s == k.to_i.to_s) ? k.to_i : k.to_sym] } }
+  end
+
+  def get_clients()
+    clients = []
+
+    if req = api_request(:GET, "/clients")
+      if req.code == '200'
+        JSON.parse(req.body).each do |client|
+          clients << client['name']
+        end
+      end
+    end
+
+    clients
+  end
+
+  def run()
+    problems = 0
+
+    @clients.each do |client|
+      query = config[:query].gsub(" WHERE ", " WHERE #{config[:host_field]} = '#{client}' AND ")
+      puts "* Query: #{query.inspect}" if config[:debug]
+      begin
+        records = @influxdb.query(query)
+        records.each do |record|
+          puts "    - Result: #{record.inspect}" if config[:debug]
+
+          value = @json_path.on(record).first
+
+          record_s = record.symbolize_recursive
+          check_name = "influxdb-q-#{interpolate(config[:check_name], record_s)}"
+          msg = interpolate(config[:msg], record_s)
+
+          if value != nil
+            if config[:crit] and @calculator.evaluate(config[:crit], value: value)
+              send_critical(check_name, client, "#{msg} - Value: #{value} (#{config[:crit]})")
+            elsif config[:warn] and @calculator.evaluate(config[:warn], value: value)
+              send_warning(check_name, client, "#{msg} - Value: #{value} (#{config[:warn]})")
+            else
+              send_ok(check_name, client, "#{msg} - Value: #{value}")
+            end
+          else
+            send_unknown(check_name, client, "#{msg} - Value: N/A")
+          end
+        end
+        puts if config[:debug]
+      rescue
+        STDERR.puts($!)
+        problems += 1
+      end
+    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
+  end
+end

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

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

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

@@ -0,0 +1 @@
+require 'sensu-plugins-influxdb-q/version'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-influxdb-q
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+description: This plugin provides facilities for running queries against InfluxDB
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-influxdb-q.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-influxdb-q.rb
+- lib/sensu-plugins-influxdb-q.rb
+- lib/sensu-plugins-influxdb-q/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-influxdb-q
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring using InfluxDB query language
+test_files: []