check_http_json.rb

#!/usr/bin/env ruby

# Name: check_http_json.rb
# Author: https://github.com/phrawzty/check_http_json/commits/master
# Description: Nagios plugin that makes an HTTP connection and parses the JSON result.
#
# Copyright 2012 Daniel Maher
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Requires.
require 'rubygems' # fix compatibility with ruby 1.8.7 (json)
require 'json'
require 'net/http'
require 'net/https'
require 'uri'
require 'optparse'
require 'timeout'

# Manage Nagios messages and exit code
module Nagios
    class << self
        # Constant of exit codes, used as message prefix.
        CODES = {
            0 => 'OK',
            1 => 'WARN',
            2 => 'CRIT',
            3 => 'UNKNOWN'
        }.freeze

        # Standard issue getter and setter.
        # Nagios.perf => append Perf output
        # Nagios.verbose = true|false => force unknown on exit
        # Nagios.output_alt_pipe => substitute pipes in output
        attr_accessor :perf, :verbose, :output_alt_pipe

        # Use default writer (like critical, but without exit).
        # Nagios.ok/warning/unknown = <nagios message>
        attr_writer :ok, :warning, :unknown

        def initialize
            @verbose = false
        end

        def critical=(msg)
            @critical = msg
            # Force exit on critical.
            do_exit
        end

        # Get current exit code; prioritized from critical to ok.
        def msg_code
            return @critical, 2 if @critical
            return @warning, 1 if @warning
            return @unknown, 3 if @unknown
            [@ok, 0]
        end

        # Output one-liner, optional set explicitly code and msg.
        def do_exit(code = nil, msg = nil)
            msg, code = msg_code unless code
            # Substitute pipes because that symbol is sacred to Nagios (see issue #42).
            msg = msg.to_s.gsub "|", @output_alt_pipe.to_s
            puts '%s: %s' % [CODES[code.to_i], msg.to_s] + @perf.to_s
            exit 3 if @verbose
            exit code
        end
    end
end

# Herp derp.
options = {}

# Def jam.

# Display verbose output (if being run by a human for example).
def say (v, msg)
    if v == true
        puts '+ %s' % [msg]
    end
end

# The results may be nested hashes; flatten that out into something manageable.
def hash_flatten(hash, delimiter, prefix = nil, flat = {})
    if hash.is_a? Array then
        hash.each_index do |index|
            newkey = index
            newkey = '%s%s%s' % [prefix, delimiter, newkey] if prefix
            val = hash[index]
            hash_flatten val, delimiter, newkey, flat
        end
    elsif hash.is_a? Hash then
        hash.keys.each do |key|
            newkey = key
            newkey = '%s%s%s' % [prefix, delimiter, key] if prefix
            val = hash[key]
            hash_flatten val, delimiter, newkey, flat
        end
    else
        flat[prefix] = hash
    end

    return flat
end

# Parse the nutty Nagios range syntax.
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
def nutty_parse(thresh, want, got, v, element)
    retval = 'FAIL'

    # if there is a non-numeric character we have to deal with that
    # got < want
    if want =~ /^(\d+):$/ then
        if got.to_i < $1.to_i then
            retval = '%s is below threshold value %s (%s)' % [element, $1, got]
        else
            retval = 'OK'
        end
    end

    # got > want
    if want =~ /^~:(\d+)$/ then
        if got.to_i > $1.to_i then
            retval = '%s is above threshold value %s (%s)' % [element, $1, got]
        else
            retval = 'OK'
        end
    end

    # outside specific range
    if want =~ /^(\d+):(\d+)$/ then
        if got.to_i < $1.to_i or got.to_i > $2.to_i then
            retval = '%s is outside expected range [%s:%s] (%s)' % [element, $1, $2, got]
        else
            retval = 'OK'
        end
    end

    # inside specific range
    if want =~ /^@(\d+):(\d+)$/ then
        if got.to_i >= $1.to_i and got.to_i <= $2.to_i then
            retval = '%s is in  value range [%s:%s] (%s)' % [element, $1, $2, got]
        else
            retval = 'OK'
        end
    end

    # otherwise general range
    if not want =~ /\D/ then
        if got.to_i > want.to_i then
            retval = '%s is above threshold value %s (%s)' % [element, want, got]
        elsif got.to_i < 0  then
            retval = '%s is below 0 (%s)' % [element, got]
        else
            retval = 'OK'
        end
    end

    if retval == 'OK' then
        say(v, '%s threshold not exceeded.' % [thresh])
    elsif retval == 'KO' then
        say(v, '%s threshold exceeded.' % [thresh])
    else
        say(v, '"%s" is a strange and confusing %s value.' % [want, thresh])
    end

    return retval
end

# Deal with a URI target.
def uri_target(options)
    uri = URI.parse(options[:uri])
    http = Net::HTTP.new(uri.host, uri.port)

    if uri.scheme == 'https' then
        http.use_ssl = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    end

    # Timeout handler, just in case.
    response = nil
    begin
        Timeout::timeout(options[:timeout]) do
            request = Net::HTTP::Get.new(uri.request_uri)
            if (options[:user] and options[:pass]) then
                request.basic_auth(options[:user], options[:pass])
            end
            if (options[:headers]) then
                options[:headers].each do |h|
                    k,v = h.split(':')
                    request[k] = v
                end
            end
            response = http.request(request)
        end
    # Not sure whether a timeout should be CRIT or UNKNOWN. -- phrawzty
    rescue Timeout::Error
        say(options[:v], 'The HTTP connection timed out after %i seconds.' % [options[:timeout]])
        msg = 'Connection timed out.'
        Nagios.do_exit(2, msg)
    rescue Exception => e
        say(options[:v], 'Exception occured: %s.' % [e])
        msg = 'HTTP connection failed.'
        Nagios.do_exit(3, msg)
    end

    # We must get a 200 response; if not, the user might want to know.
    if not response.code.to_i == 200 then
        level = options[:status_level_default]
        if options[:status_level] then
            options[:status_level].each do |s|
                k,v = s.split(':')
                if response.code.to_i == k.to_i
                    level = v.to_i
                    break
                end
            end
        end
        if not level == 0 then
            msg = 'Received HTTP code %s instead of 200.' % [response.code]
            Nagios.do_exit(level.to_i, msg)
        end
    end

    say(options[:v], "RESPONSE:\n---\n%s\n---" % [response.body])

    begin
        # Make a JSON object from the response.
        json = JSON.parse response.body
    rescue Exception => e
        say(options[:v], 'Could not parse JSON from HTTP response: %s.' % [e])
        msg = 'Parsing JSON failed.'
        Nagios.do_exit(3, msg)
    end

    return json
end

# Deal with a file target.
def file_target(options)
    # The file must exist and be readable.
    state = nil

    if not File.exist?(options[:file]) then
        state = 'does not exist'
    elsif not File.readable?(options[:file]) then
        state = 'is not readable'
    end

    if state then
        msg = '%s %s.' % [options[:file], state]
        Nagios.do_exit(2, msg)
    end

    begin
        # Make a JSON object from the contents of the file.
        json = JSON.parse(File.read(options[:file]))
    rescue Exception => e
        say(options[:v], 'Could not parse JSON from input file: %s.' % [e])
        msg = 'Parsing JSON failed.'
        Nagios.do_exit(3, msg)
    end

    return json
end

# Parse cli args.
def parse_args(options)
    optparse = OptionParser.new do |opts|
        opts.banner = 'Usage: %s -u <URI> -e <element> -w <warn> -c <crit>' % [$0]

        opts.on('-h', '--help', 'Help info.') do
            puts opts
            Nagios.verbose = true
            Nagios.do_exit(3, nil)
        end

        options[:v] = false
        opts.on('-v', '--verbose', 'Additional human output.') do
            options[:v] = true
            Nagios.verbose = true
        end

        options[:uri] = nil
        opts.on('-u', '--uri URI', 'Target URI. Incompatible with -f.') do |x|
            options[:uri] = x
        end

        options[:user] = nil
        opts.on('--user USERNAME', 'HTTP basic authentication username.') do |x|
            options[:user] = x
        end

        options[:pass] = nil
        opts.on('--pass PASSWORD', 'HTTP basic authentication password.') do |x|
            options[:pass] = x
        end

        options[:headers] = nil
        opts.on('--headers HEADERS', 'Comma-separated list of HTTP headers to include (ex. HOST:somehost,AUTH:letmein).') do |x|
            options[:headers] = x.split(',')
        end

        options[:status_level] = nil
        opts.on('--status_level STRING', 'Comma-separated list of HTTP status codes and their associated Nagios alert levels (ex. 301:1,404:2).') do |x|
            options[:status_level] = x.split(',')
        end

        options[:status_level_default] = 1
        opts.on('--status_level_default VALUE', 'The default return code for unexpected HTTP status codes. Defaults to 1.') do |x|
            options[:status_level_default] = x.to_i
        end

        options[:file] = nil
        opts.on('-f', '--file PATH', 'Target file. Incompatible with -u.') do |x|
            options[:file] = x
        end

        options[:element_string] = []
        opts.on('-e', '--element ELEMENT...', 'Desired element (ex. foo=>bar=>ish is foo.bar.ish). Repeatable argument.') do |x|
            options[:element_string].push x
        end

        options[:element_regex] = nil
        opts.on('-E', '--element_regex REGEX', 'Desired element expressed as regular expression.') do |x|
            options[:element_regex] = x
        end

        options[:element_regex_global] = false
        opts.on('--element_regex_global', 'Check all occurring matches. -E is required.') do
            options[:element_regex_global] = true
        end

        options[:delimiter] = '.'
        opts.on('-d', '--delimiter CHARACTER', 'Element delimiter (default is period).') do |x|
            options[:delimiter] = x
        end

        options[:warn] = nil
        opts.on('-w', '--warn VALUE', 'Warning threshold (integer or Nagios threshold ranges format).') do |x|
            options[:warn] = x.to_s
        end

        options[:crit] = nil
        opts.on('-c', '--crit VALUE', 'Critical threshold (integer or Nagios threshold ranges format).') do |x|
            options[:crit] = x.to_s
        end

        options[:result_string] = nil
        opts.on('-r', '--result STRING', 'Expected string result. No need for -w or -c.') do |x|
            options[:result_string] = x
        end

        options[:result_regex] = nil
        opts.on('-R', '--result_regex REGEX', 'Expected string result expressed as regular expression. No need for -w or -c.') do |x|
            options[:result_regex] = x
        end

        options[:result_string_warn] = nil
        opts.on('-W', '--result_warn STRING', 'Warning if element is [string]. -C is required.') do |x|
            options[:result_string_warn] = x
        end

        options[:result_string_unknown] = nil
        opts.on('-U', '--result_unknown STRING', 'Unknown if element is [string]. -C is required.') do |x|
            options[:result_string_unknown] = x
        end

        options[:result_string_crit] = nil
        opts.on('-C', '--result_crit STRING', 'Critical if element is [string]. -W is required.') do |x|
            options[:result_string_crit] = x
        end

        options[:result_regex_warn] = nil
        opts.on('--result_warn_regex REGEX', 'Warning if element matches REGEX. --result_crit_regex is required.') do |x|
            options[:result_regex_warn] = x
        end

        options[:result_regex_unknown] = nil
        opts.on('--result_unknown_regex REGEX', 'Unknown if element matches REGEX. --result_crit_regex is required.') do |x|
            options[:result_regex_unknown] = x
        end

        options[:result_regex_crit] = nil
        opts.on('--result_crit_regex REGEX', 'Critical if element matches REGEX. --result_warn_regex is required.') do |x|
            options[:result_regex_crit] = x
        end

        options[:perf_string] = nil
        opts.on('-p', '--perf ELEMENT', 'Output additional fields (performance metrics); comma-separated.') do |x|
            options[:perf_string] = x
        end

        options[:perf_splitter] = ','
        opts.on('--perf_splitter CHARACTER', 'Specify an alternative character to split performance keys.') do |x|
            options[:perf_splitter] = x
        end

        options[:output_alt_pipe] = '!'
        opts.on('--output_alt_pipe CHARACTER', 'Specify a character to replace reserved pipes in the output. Default: !') do |x|
            options[:output_alt_pipe] = x
        end

        options[:perf_regex] = nil
        opts.on('--perf_regex REGEX', 'Output additional fields (performance metrics) expressed as regular expression.') do |x|
            options[:perf_regex] = x
        end

        options[:perf_regex_global] = false
        opts.on('--perf_regex_global', 'Check all occurring matches. --perf-regex is required.') do
            options[:perf_regex_global] = true
        end

        options[:timeout] = 5
        opts.on('-t', '--timeout SECONDS', 'Wait before HTTP timeout.') do |x|
            options[:timeout] = x.to_i
        end
    end

    optparse.parse!
    return options
end

# Sanity check.
def sanity_check(options)
    # In life, some arguments cannot be avoided.
    error_msg = []

    if not (options[:uri] or options[:file]) then
        error_msg.push('Must specify target URI or file.')
    end

    if (options[:user] and not options[:pass]) or (options[:pass] and not options[:user]) then
        error_msg.push('Must specify both a username and a password for basic auth.')
    end

    if (options[:uri] and options[:file]) then
        error_msg.push('Must specify either target URI or file, but not both.')
    end

    if options[:element_string].empty? and options[:element_regex].nil? then
        error_msg.push('Must specify a desired element.')
    end

    if options[:element_string].any? and options[:element_regex] then
        error_msg.push('Must specify either an element string OR an element regular expression.')
    end

    if options[:delimiter].length > 1
        error_msg.push('Delimiter must be a single character.')
    end

    if not ((options[:result_string] or options[:result_regex]) or (options[:warn] and options[:crit]) or (options[:result_string_warn] and options[:result_string_crit]) or (options[:result_regex_warn] and options[:result_regex_crit])) then
        error_msg.push('Must specify an expected result OR the warn and crit thresholds.')
    end

    if options[:result_string] and options[:result_regex] then
        error_msg.push('Must specify either a result string OR result regular expression.')
    end

    if options[:perf_string] and options[:perf_regex] then
        error_msg.push('Must specify either a perf string OR a perf regular expression.')
    end

    if options[:output_alt_pipe] then
        Nagios.output_alt_pipe = options[:output_alt_pipe]
    end

    if error_msg.length > 0 then
        # First line is Nagios-friendly.
        puts 'UNKNOWN: Insufficient or incompatible arguments.'
        # Subsequent lines are for humans.
        error_msg.each do |msg|
            puts msg
        end
        msg = '"%s --help" for more information.' % [$0]
        Nagios.verbose = true
        Nagios.do_exit(3, msg)
    end
end



# Run Lola Run.

# Choose your arguments wisely.
options = parse_args(options)
sanity_check(options)

# Set up the json object.
json = nil

# If the target is a URI.
if options[:uri] then
    json = uri_target(options)
end

# If the target is a file.
if options[:file] then
    json = file_target(options)
end

# Flatten that bad boy.
json_flat = hash_flatten(json, options[:delimiter])

# If performance metrics have been requested...
if options[:perf_string] then
    options[:perf_string] = options[:perf_string].split(options[:perf_splitter])
end

# If performance metrics have been specified as an array…
if options[:perf_string].is_a?(Array) then
    p = []
    options[:perf_string].each do |x|
        if json_flat.has_key?(x) then
            say(options[:v], 'Perf metric %s is %s' % [x, json_flat[x]])
            p.push("%s=%s" % [x, json_flat[x]])
        end
    end
    # Build a nice output string (issue #17).
    Nagios.perf = ' | ' + p.join(' ')
end

# If performance metric is a regex...
if options[:perf_regex] then
    options[:perf_regex] = options[:perf_regex].split(options[:perf_splitter])
end

if options[:perf_regex].is_a?(Array) then
    p = []
    options[:perf_regex].each do |x|
        json_flat.each do |k, _|
            next unless k =~ Regexp.new(x)

            say(options[:v], 'Found perf %s as %s' % [x, k])
            p.push("%s=%s" % [k, json_flat[k]])
            # do not add all elements if not enabled
        break unless options[:perf_regex_global]
        end
    end
    # Build a nice output string (issue #17).
    Nagios.perf = ' | ' + p.join(' ')
end

# ensure element is an array
options[:element] = []

# used in ok message to represent configured check element
element_message_name = ''

# If the element is a string...
unless options[:element_string].empty?
    element_message_name = options[:element_string].join(',')
    options[:element] = options[:element_string]
end

# If the element is a regex...
if options[:element_regex]
    element_message_name = 'First'
    element_message_name = 'All' if options[:element_regex_global]
    element_message_name = "%s '%s' (regex)" % [element_message_name, options[:element_regex]]

    json_flat.each do |k, _|
        next unless k =~ Regexp.new(options[:element_regex])

        say(options[:v], 'Found %s as %s' % [options[:element_regex], k])
        options[:element].push k
        # do not add all elements if not enabled
        break unless options[:element_regex_global]
    end
    if options[:element].empty?
        msg = '%s not found in response.' % [options[:element_regex]]
        Nagios.critical = msg
    end
end

# Build OK message
if options[:result_string]
    Nagios.ok = '%s does match \'%s\'' % [element_message_name, options[:result_string]]
elsif options[:result_regex]
    Nagios.ok = '\'%s\' (regex) does match \'%s\'' % [element_message_name, options[:result_regex]]
end

if options[:result_string_warn] && options[:result_string_crit]
    Nagios.ok = '%s does not match \'%s\' or \'%s\'' % [element_message_name, options[:result_string_warn], options[:result_string_crit]]
elsif options[:result_regex_warn] && options[:result_regex_crit]
     Nagios.ok = '%s does not match (REGEX) \'%s\' or \'%s\'' % [element_message_name, options[:result_regex_warn], options[:result_regex_crit]]
end

if options[:crit]
    Nagios.ok = '%s within treshold W:%s C:%s' % [element_message_name, options[:warn], options[:crit]]
end

# Check all elements
options[:element].each do |element|
    unless json_flat.key?(element)
        Nagios.critical = '%s not found in response.' % [element]
    end

    element_value = json_flat[element]
    say(options[:v], 'The value of %s is %s' % [element, element_value])

    # If we're looking for a string...
    if options[:result_string] || options[:result_regex]
        msg = '%s is %s' % [element, element_value]
        if options[:result_regex]
            say(options[:v], 'Will match %s against \'%s\'' % [element.to_s, options[:result_regex]])
            string_match = element_value.to_s =~ Regexp.new(options[:result_regex])
        else
            string_match = (element_value.to_s == options[:result_string].to_s)
        end

        # check next element on match
        next if string_match

        # do not check for warn or crit string, assume its critical
        Nagios.critical = msg unless options[:result_string_warn] && options[:result_string_crit]
    end

    # If we're specifying critical & warning strings...
    if options[:result_string_warn] && options[:result_string_crit]
        say(options[:v], '%s should not match against \'%s\', else CRIT' % [element, options[:result_string_crit]])
        say(options[:v], '%s should not match against \'%s\', else WARN' % [element, options[:result_string_warn]])
        msg = '%s matches %s' % [element, element_value]

        case element_value.to_s
        when options[:result_string_crit].to_s
            Nagios.critical = msg
        when options[:result_string_warn].to_s
            Nagios.warning = msg
        when options[:result_string_unknown].to_s
            Nagios.unknown = msg
        end
        # check next element
        next
    end

    # If we're specifying critical & warning regex...
    if options[:result_regex_warn] && options[:result_regex_crit]
        say(options[:v], '%s should not match against \'%s\' (REGEX), else CRIT' % [element, options[:result_regex_crit]])
        say(options[:v], '%s should not match against \'%s\' (REGEX), else WARN' % [element, options[:result_regex_warn]])
        msg = '%s matches %s' % [element, element_value]

        case element_value.to_s
        when Regexp.new(options[:result_regex_crit].to_s)
            Nagios.critical = msg
        when Regexp.new(options[:result_regex_warn].to_s)
            Nagios.warning = msg
        when Regexp.new(options[:result_regex_unknown].to_s)
            Nagios.unknown = msg
        end
        # check next element
        next
    end

    # If we're dealing with threshold values...

    # Numbahs only, brah.
    if element_value =~ /\D/
        say(options[:v], 'The value of %s contains non-numeric characters.' % [element])
        Nagios.unknown = 'Return value syntax failure.'
        next
    end

    # check crit threshold
    if options[:crit]
        crit = nutty_parse('Critical', options[:crit], element_value, options[:v], element)
        if crit == 'FAIL'
            Nagios.unknown = 'Critical threshold syntax failure.'
            next
        end
        Nagios.critical = crit unless crit == 'OK'
    end

    # check warn threshold
    warn = nutty_parse('Warning', options[:warn], element_value, options[:v], element)
    if warn == 'FAIL'
        Nagios.unknown = 'Warn threshold syntax failure.'
        next
    end
    Nagios.warning = warn unless warn == 'OK'
end

# Finally output the message and exit.
Nagios.do_exit