sensu-plugins/sensu-plugins-network-checks

View on GitHub
bin/check-ports-nmap.rb

Summary

Maintainability
A
2 hrs
Test Coverage
#! /usr/bin/env ruby
# frozen_string_literal: true

#
#   check-ports-nmap
#
# DESCRIPTION:
#   Fetch port status using nmap. This check is good for catching bad network ACLs
#   or service down events for network resources.
#
# OUTPUT:
#   plain text
#
# PLATFORMS:
#   Linux, Windows, BSD, Solaris, etc
#
# DEPENDENCIES:
#   gem: sensu-plugin
#   nmap package
#
# USAGE:
#   $ ./check-ports-nmap.rb --host some_server --ports 5671,5672 --level crit
#
# NOTES:
#   #YELLOW
#   Look at rewriting this using the namp library to not depend on external tools
#
# LICENSE:
#   Copyright 2013 GoDaddy.com, LLC <jjmanzer@godaddy.com>
#   Released under the same terms as Sensu (the MIT license); see LICENSE
#   for details.
#

require 'open3'
require 'sensu-plugin/check/cli'
require 'json'

# CheckPorts
class CheckPorts < Sensu::Plugin::Check::CLI
  option :host,
         description: 'Resolving name or IP address of target host',
         short: '-h HOST',
         long: '--host HOST',
         default: 'localhost'

  option :ports,
         description: 'TCP port(s) you wish to get status for',
         short: '-t PORT,PORT...',
         long: '--ports PORT,PORT...'

  option :level,
         description: 'Alert level crit(critical) or warn(warning)',
         short: '-l crit|warn',
         long: '--level crit|warn',
         default: 'WARN'

  def run
    stdout, stderr = Open3.capture3(
      ENV,
      "nmap -P0 -p #{config[:ports]} #{config[:host]}"
    )

    case stderr
    when /Failed to resolve/
      critical 'cannot resolve the target hostname'
    end

    port_checks = {}
    check_pass  = true

    stdout.split("\n").each do |line|
      line.scan(/(\d+).tcp\s+(\w+)\s+(\w+)/).each do |status|
        port_checks[status[1]] ||= []
        port_checks[status[1]].push status[0]
        check_pass = false unless status[1]['open']
      end
    end

    result = port_checks.map { |state, ports| "#{state}:#{ports.join(',')}" }.join(' ')

    if check_pass
      ok result
    elsif config[:level].casecmp('WARN').zero?
      warning result
    elsif config[:level].casecmp('CRIT').zero?
      critical result
    else
      unknown "Unknown alert level #{config[:level]}"
    end
  end
end