check-conditional-aggregate 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66d1b48f59a4b76508fdc876623c9adfd3156f81
+  data.tar.gz: e6ceccd34cc8dd94d9b0bfb03100cf6acb8927d0
+SHA512:
+  metadata.gz: 3b4715295d1b68fd91c444043f4b710f7ff61b7f525c6f84f288d1b57454e513799764a03f94d21cee57d137b5fbf36e6975356bfd0d5294a937a3b704f1e1c6
+  data.tar.gz: 7e8947aefcb5944bcf1c932fda1e2c6eb8a505e30a53c287ef3b530ec6ff3fa9d8905a0db054a3ce31f7d0f3d9a9fdcbc0cb20d29d6503e19ee5e9e5134191dc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in check-conditional-aggregate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    check-conditional-aggregate (0.0.4)
+      rest-client
+      sensu-plugin
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    geminabox (0.12.4)
+      builder
+      faraday
+      httpclient (>= 2.2.7)
+      nesty
+      sinatra (>= 1.2.7)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    httpclient (2.6.0.1)
+    json (1.8.3)
+    mime-types (2.6.2)
+    mixlib-cli (1.5.0)
+    multipart-post (2.0.0)
+    nesty (1.0.2)
+    netrc (0.10.3)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sensu-plugin (1.2.0)
+      json
+      mixlib-cli (>= 1.1.0)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  check-conditional-aggregate!
+  geminabox
+  rake (~> 10.0)
+  rspec
+  rspec-mocks
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andre Thenot
+
+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,65 @@
+# Check::Conditional::Aggregate
+
+Plugin for Sensu to run an aggregate of other aggregates, following some simple logic rules. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'check-conditional-aggregate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install check-conditional-aggregate
+
+## Usage
+
+Synopsis
+
+    # Generate a warning alert if ANY checks have ANY critical hosts.
+    check-conditional -a API -c "check_foo,check_bar" --warning "any critical in any"
+    
+    # Generate a critical if either check_foo or check_bar has all hosts at critical.
+    check-conditional -a API -c "check_foo,check_bar" --critical "all warning in any"
+    
+    # Generate a warning if 80% or more of the checks are critical in any of the checks
+    check-conditional -a API -c CHECKS --warning "80% critical in any"
+    
+
+General form:
+
+    check-conditional -a API -c CHECKS [ --critical EXPRESSION | --warning EXPRESSION ]
+
+CHECKS is a list of one or more comma-separated aggregate checkers. These return a tally of hosts that are OK, in warning state and in critical state. These results are then rolled up to generate a critical or warning depending on whether the associated EXPRESSION matches. The two options can be used together, so you can define a broader expression to generate a warning and a tighter expression that generates a critcal state. The expression syntax is:
+
+    any|all|N% critical|warning in any|all
+
+The quantifier on the left determines what threshold to apply as each check is being considered, and the quantifier on the right expresses how the results get rolled up.
+
+## Example
+
+Suppose we have 3 aggregate checks that monitor latency in 3 regions, and we want to produce an overall health. For the purpose of this 
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Release Notes
+### 0.0.3
+- Perform logic accross multiple aggregate checkers using --checks "Check1,Check2,..."
+- Removed pattern matching (had been deprecated/broken anyways)
+
+### 0.0.2
+- Fixed bug pertaining to specifying --critical and --warning at the same time.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/check-conditional-aggregate.rb

@@ -0,0 +1,218 @@
+#!/usr/bin/env ruby
+# Check Aggregate with Conditional
+# ===
+#
+# Authors
+# ===
+# Sean Porter, @portertech
+# Andre Thenot, @athenot
+#
+# Copyright 2012 Sonian, Inc., 2015 Cisco Systems, Inc.
+#
+# Released under the same terms as Sensu (the MIT license); see
+# LICENSE for details.
+
+require 'rubygems'
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+# Subclass of Sensu Plugin Checker. Conforms to Sensu plugin API.
+class CheckConditionalAggregate < Sensu::Plugin::Check::CLI
+  option :api,
+         short: '-a URL',
+         long: '--api URL',
+         description: 'Sensu API URL',
+         default: 'http://localhost:4567'
+
+  option :user,
+         short: '-u USER',
+         long: '--user USER',
+         description: 'Sensu API USER'
+
+  option :password,
+         short: '-p PASSWORD',
+         long: '--password PASSWORD',
+         description: 'Sensu API PASSWORD'
+
+  option :timeout,
+         short: '-t SECONDS',
+         long: '--timeout SECONDS',
+         description: 'Sensu API connection timeout in SECONDS',
+         proc: proc(&:to_i),
+         default: 30
+
+  option :checks,
+         short: '-c CHECK',
+         long: '--checks CHECK',
+         description: 'Aggregate CHECK name'
+
+  option :age,
+         short: '-A SECONDS',
+         long: '--age SECONDS',
+         description: 'Minimum aggregate age in SECONDS, time since check request issued',
+         default: 30,
+         proc: proc(&:to_i)
+
+  option :limit,
+         short: '-l LIMIT',
+         long: '--limit LIMIT',
+         description: 'Limit of aggregates you want the API to return',
+         proc: proc(&:to_i)
+
+  option :summarize,
+         short: '-s',
+         long: '--summarize',
+         boolean: true,
+         description: 'Summarize check result output',
+         default: false
+
+  option :warning,
+         short: '-W CONDITION',
+         long: '--warning CONDITION',
+         description: 'CONDITION to trigger warning (any|all|N% warning|critical)'
+
+  option :critical,
+         short: '-C CONDITION',
+         long: '--critical CONDITION',
+         description: 'CONDITION to trigger critical (any|all|N% warning|critical)'
+
+  option :message,
+         short: '-M MESSAGE',
+         long: '--message MESSAGE',
+         description: 'A custom error MESSAGE'
+
+  # Main body.
+  def run
+    run_checks(config[:critical], config[:warning], (config[:message] or ''), config[:checks])
+  end
+
+  # REST request to API; handle various failures gracefully
+  # rubocop:disable Metrics/AbcSize
+  def api_request(resource)
+    request = RestClient::Resource.new(config[:api] + resource, timeout: config[:timeout],
+                                                                user: config[:user],
+                                                                password: config[:password])
+    JSON.parse(request.get, symbolize_names: true)
+  rescue RestClient::ResourceNotFound
+    warning "Resource not found: #{resource}"
+  rescue Errno::ECONNREFUSED
+    warning 'Connection refused'
+  rescue RestClient::RequestFailed
+    warning 'Request failed'
+  rescue RestClient::RequestTimeout
+    warning 'Connection timed out'
+  rescue RestClient::Unauthorized
+    warning 'Missing or incorrect Sensu API credentials'
+  rescue JSON::ParserError
+    warning 'Sensu API returned invalid JSON'
+  end
+
+  # Read from API
+  def acquire_aggregate(checkName)
+    # Query Sensu for aggregate timestamps
+    uri = "/aggregates/#{checkName}"
+    issued = api_request(uri + "?age=#{config[:age]}" + (config[:limit] ? "&limit=#{config[:limit]}" : ''))
+
+    # Look for the latest and get the data for that aggregate
+    if !issued.empty?
+      issuedSorted = issued.sort
+      time = issuedSorted.pop
+      if !time.nil?
+        uri += "/#{time}"
+        uri += '?summarize=output' if config[:summarize]
+        checkResult = api_request(uri)
+      else
+        warning "No aggregates older than #{config[:age]} seconds"
+      end
+    else
+      warning "No aggregates for #{checkName}"
+    end
+    checkResult
+  end
+
+  # Comparison logic below
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+
+  # Perform comparison based on expression rules
+  def compare_threshold(aggregate, quantifier, level, checkName) # rubocop:ignore Metrics/CyclomaticComplexity
+    # Syntax: "any|all|n% warning|critical"
+    symbolLevel = { 'critical' => :critical, 'warning' => :warning }[level]
+
+    # Emit a message if the condition (any, all or percentage) matches.
+    if /(?<percent>\d{1,2})%/ =~ quantifier
+      # A percentage matches
+      percent = percent.to_f
+      if aggregate[symbolLevel].to_i != 0 && aggregate[symbolLevel].to_f * 100 / aggregate[:total].to_f >= percent
+        "#{checkName} @ #{percent}% or more #{level} (#{aggregate[symbolLevel]}/#{aggregate[:total]}), "
+      end
+    elsif quantifier == 'any' && aggregate[symbolLevel].to_f > 0
+      # One or more match
+      "#{checkName} @ one or more #{level}, "
+    elsif quantifier == 'all' && aggregate[:total].to_f != 0 && aggregate[symbolLevel].to_f == aggregate[:total].to_f
+      # All match
+      "#{checkName} @ all #{level}, "
+    else
+      nil # OK
+    end
+  end
+
+  # Iterate over all the checks, get their latest aggregate values and evaluate them against the expressions.
+  def run_checks(configCritical, configWarning, configMessage, configChecks)
+    # Parse the match expression
+    critQuantifier, critLevel, _, critRollupQuantifier = configCritical.split(/\s+/) if configCritical
+    warnQuantifier, warnLevel, _, warnRollupQuantifier = configWarning.split(/\s+/) if configWarning
+
+    # Grab the list of aggregate checkers passed
+    critCount = warnCount = 0
+    checks = configChecks.split(/,/)
+    totalCheckCount = checks.length
+    message = configMessage + ' triggered by '
+
+    # Run each check and see what matches
+    checks.each do |checkName|
+      aggregate = acquire_aggregate(checkName)
+
+      # Look for matches based on expression passed for Critical level
+      if configCritical
+        critMessage = compare_threshold(aggregate, critQuantifier, critLevel, checkName)
+        if critMessage
+          critCount += 1
+          message += critMessage
+        end
+      end
+
+      # Look for matches based on expression passed for Warning level
+      if configWarning
+        warnMessage = compare_threshold(aggregate, warnQuantifier, warnLevel, checkName)
+        if warnMessage
+          warnCount += 1
+          message += warnMessage
+        end
+      end
+    end
+
+    # Tidy up human-readable string
+    message = message[0..-3]
+
+    # Tally up results based on the rollup criteria and generate the actual WARNING or CRITICAL exits.
+    if configCritical
+      if critRollupQuantifier == 'all' && critCount == totalCheckCount
+        critical message + ' (in all checks)'
+      elsif critRollupQuantifier == 'any' && critCount.to_i > 0
+        critical message + ' (in any check)'
+      end
+    end
+    if configWarning
+      if warnRollupQuantifier == 'all' && warnCount == totalCheckCount
+        warning message + ' (in all checks)'
+      elsif warnRollupQuantifier == 'any' && warnCount.to_i > 0
+        warning message + ' (in any check)'
+      end
+    end
+
+    # Neither condition matched so that means we're in an OK state.
+    ok 'Aggregate looks GOOD'
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'check-conditional-aggregate'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: check-conditional-aggregate
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Andre Thenot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-30 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Plugin for Sensu to run an aggregate of other aggregates, following some
+  simple logic rules.
+email:
+- andrthen@cisco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check-conditional-aggregate.rb
+- bin/console
+- bin/setup
+homepage: https://github.com/athenot/check-conditional-aggregate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- bin
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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 plugin to aggregate checks based on conditions.
+test_files: []