sensu-plugins-network-checks 0.0.1.alpha.2

data/bin/check-ports.rb

@@ -0,0 +1,91 @@
+#! /usr/bin/env ruby
+#
+#   check-ports
+#
+# 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
+#   gem: open3
+#   gem: json
+#   nmap
+#
+# USAGE:
+#   $ ./check-ports.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 # rubocop:disable all
+    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].upcase == 'WARN'
+      warning result
+    elsif config[:level].upcase == 'CRIT'
+      critical result
+    else
+      unknown "Unknown alert level #{config[:level]}"
+    end
+  end
+end

data/bin/check-rbl.rb

@@ -0,0 +1,102 @@
+#! /usr/bin/env ruby
+#
+#   check-rbl
+#
+# DESCRIPTION:
+#   Checks if a ip is blacklisted in the common dns blacklists. You can
+#   add a list
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: dnsbl-client
+#
+# USAGE:
+#
+# NOTES:
+#  A list of DNS blacklists to not be checked can be passed with -I as a
+#  comma-separated list.
+#
+# LICENSE:
+#   Copyright 2012 Sarguru Nathan  <sarguru90@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'dnsbl-client'
+require 'set'
+
+#
+# Rbl Check
+#
+class RblCheck < Sensu::Plugin::Check::CLI
+  option :ip,
+         short: '-i IPADDRESS',
+         long: '--ip IPADDRESS',
+         description: 'IP of the server to check'
+
+  option :ignored_bls,
+         short: '-I BLACKLISTNAME',
+         long: '--ignored_bls BLACKLISTNAME',
+         description: 'Comma Separated String of ignored blacklists from default list',
+         default: 'null'
+
+  option :critical_bls,
+         short: '-C BLACKLISTNAME',
+         long: '--critical_bls BLACKLISTNAME',
+         description: 'Comma Separated String of critical blacklists from default list',
+         default: 'null'
+
+  def run # rubocop:disable all
+    c = DNSBL::Client.new
+
+    if config[:ip]
+      ip_add = config[:ip]
+    else
+      critical 'plugin failed. Required Argument -i (ip address of the client)'
+    end
+
+    if config[:ignored_bls]
+      ignored_bls = config[:ignored_bls]
+      ignored_bls_set = ignored_bls.split(',').to_set
+    end
+
+    if config[:critical_bls]
+      critical_bls = config[:critical_bls]
+      critical_bls_set = critical_bls.split(',').to_set
+    end
+
+    dnsbl_ret   = c.lookup("#{ip_add}")
+    msg_string  = ''
+    criticality = 0
+
+    # #YELLOW
+    dnsbl_ret.each do |dnsbl_result| # rubocop:disable Style/Next
+      if dnsbl_result.meaning =~ /spam/i || dnsbl_result.meaning =~ /blacklist/i
+        unless ignored_bls_set.member?(dnsbl_result.dnsbl)
+          msg_string =  "#{msg_string} #{dnsbl_result.dnsbl}"
+        end
+
+        criticality += 1 if critical_bls_set.member?(dnsbl_result.dnsbl)
+      end
+    end
+
+    # YELLOW
+    unless msg_string.empty? # rubocop:disable UnlessElse
+      if criticality > 0
+        critical "#{ip_add} Blacklisted in#{msg_string}"
+      else
+        warning "#{ip_add} Blacklisted in#{msg_string}"
+      end
+    else
+      msg_txt = "All is well. #{ip_add} has good reputation."
+      ok "#{msg_txt}"
+    end
+  end
+end

data/bin/metrics-interface.rb

@@ -0,0 +1,83 @@
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+#   interface-metrics
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: socket
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Interface Graphite
+#
+class InterfaceGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.interface"
+
+  option :excludeinterface,
+         description: 'List of interfaces to exclude',
+         short: '-x INTERFACE[,INTERFACE]',
+         long: '--exclude-interface',
+         proc: proc { |a| a.split(',') }
+
+  def run # rubocop:disable all
+    # Metrics borrowed from hoardd: https://github.com/coredump/hoardd
+
+    metrics = %w(rxBytes
+                 rxPackets
+                 rxErrors
+                 rxDrops
+                 rxFifo
+                 rxFrame
+                 rxCompressed
+                 rxMulticast
+                 txBytes
+                 txPackets
+                 txErrors
+                 txDrops
+                 txFifo
+                 txColls
+                 txCarrier
+                 txCompressed)
+
+    File.open('/proc/net/dev', 'r').each_line do |line|
+      interface, stats_string = line.scan(/^\s*([^:]+):\s*(.*)$/).first
+      next if config[:excludeinterface] && config[:excludeinterface].find { |x| line.match(x) }
+      next unless interface
+      if interface.is_a?(String)
+        interface = interface.gsub('.', '_')
+      end
+
+      stats = stats_string.split(/\s+/)
+      next if stats == ['0'].cycle.take(stats.size)
+
+      metrics.size.times { |i| output "#{config[:scheme]}.#{interface}.#{metrics[i]}", stats[i] }
+    end
+
+    ok
+  end
+end

data/bin/metrics-net.rb

@@ -0,0 +1,92 @@
+#! /usr/bin/env ruby
+#
+#   metrics-net
+#
+# DESCRIPTION:
+#   Simple plugin that fetchs metrics from all interfaces
+#   on the box using the /sys/class interface.
+#
+#   Use the data with graphite's `nonNegativeDerivative()` function
+#   to construct per-second graphs for your hosts.
+#
+#   Loopback iface (`lo`) is ignored.
+#
+#   Compat
+#   ------
+#
+#   This plugin uses the `/sys/class/net/<iface>/statistics/{rx,tx}_*`
+#   files to fetch stats. On older linux boxes without /sys, this same
+#   info can be fetched from /proc/net/dev but additional parsing
+#   will be required.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: <?>
+#
+# USAGE:
+#   $ ./metrics-packets.rb --scheme servers.web01
+#   servers.web01.eth0.tx_packets 982965    1351112745
+#   servers.web01.eth0.rx_packets 1180186   1351112745
+#   servers.web01.eth1.tx_packets 273936669 1351112745
+#   servers.web01.eth1.rx_packets 563787422 1351112745
+#
+# NOTES:
+#   Does it behave differently on specific platforms, specific use cases, etc
+#
+# LICENSE:
+#   Copyright 2012 Joe Miller <https://github.com/joemiller>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Linux Packet Metrics
+#
+class LinuxPacketMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.net"
+
+  def run # rubocop:disable all
+    timestamp = Time.now.to_i
+
+    Dir.glob('/sys/class/net/*').each do |iface_path|
+      next if File.file?(iface_path)
+      iface = File.basename(iface_path)
+      next if iface == 'lo'
+
+      tx_pkts = File.open(iface_path + '/statistics/tx_packets').read.strip
+      rx_pkts = File.open(iface_path + '/statistics/rx_packets').read.strip
+      tx_bytes = File.open(iface_path + '/statistics/tx_bytes').read.strip
+      rx_bytes = File.open(iface_path + '/statistics/rx_bytes').read.strip
+      tx_errors = File.open(iface_path + '/statistics/tx_errors').read.strip
+      rx_errors = File.open(iface_path + '/statistics/rx_errors').read.strip
+
+      begin
+        if_speed = File.open(iface_path + '/speed').read.strip
+      rescue
+        if_speed = 0
+      end
+
+      output "#{config[:scheme]}.#{iface}.tx_packets", tx_pkts, timestamp
+      output "#{config[:scheme]}.#{iface}.rx_packets", rx_pkts, timestamp
+      output "#{config[:scheme]}.#{iface}.tx_bytes", tx_bytes, timestamp
+      output "#{config[:scheme]}.#{iface}.rx_bytes", rx_bytes, timestamp
+      output "#{config[:scheme]}.#{iface}.tx_errors", tx_errors, timestamp
+      output "#{config[:scheme]}.#{iface}.rx_errors", rx_errors, timestamp
+      output "#{config[:scheme]}.#{iface}.if_speed", if_speed, timestamp
+    end
+    ok
+  end
+end

data/bin/metrics-netif.rb

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+#
+#   netif-metrics
+#
+# DESCRIPTION:
+#   Network interface throughput
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: socket
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2014 Sonian, Inc. and contributors. <support@sensuapp.org>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Netif Metrics
+#
+class NetIFMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to .$parent.$child',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}"
+
+  def run # rubocop:disable all
+    # #YELLOW
+    `sar -n DEV 1 1 | grep Average | grep -v IFACE`.each_line do |line|  # rubocop:disable Style/Next
+      stats = line.split(/\s+/)
+      unless stats.empty?
+        stats.shift
+        nic = stats.shift
+        output "#{config[:scheme]}.#{nic}.rx_kB_per_sec", stats[2].to_f if stats[3]
+        output "#{config[:scheme]}.#{nic}.tx_kB_per_sec", stats[3].to_f if stats[3]
+      end
+    end
+
+    ok
+  end
+end

data/bin/metrics-netstat-tcp.rb

@@ -0,0 +1,110 @@
+#! /usr/bin/env ruby
+#
+#   metrics-netstat-tcp
+#
+# DESCRIPTION:
+#   Fetch metrics on TCP socket states from netstat. This is particularly useful
+#    on high-traffic web or proxy servers with large numbers of short-lived TCP
+#   connections coming and going.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: <?>
+#
+# USAGE:
+#   $ ./metrics-netstat-tcp.rb --scheme servers.hostname
+#   servers.hostname.UNKNOWN      0     1350496466
+#   servers.hostname.ESTABLISHED  235   1350496466
+#   servers.hostname.SYN_SENT     0     1350496466
+#   servers.hostname.SYN_RECV     1     1350496466
+#   servers.hostname.FIN_WAIT1    0     1350496466
+#   servers.hostname.FIN_WAIT2    53    1350496466
+#   servers.hostname.TIME_WAIT    10640 1350496466
+#   servers.hostname.CLOSE        0     1350496466
+#   servers.hostname.CLOSE_WAIT   7     1350496466
+#   servers.hostname.LAST_ACK     1     1350496466
+#   servers.hostname.LISTEN       16    1350496466
+#   servers.hostname.CLOSING      0     1350496466
+#
+# NOTES:
+#   - Code for parsing Linux /proc/net/tcp from Anthony Goddard's ruby-netstat:
+#   https://github.com/agoddard/ruby-netstat
+#
+# LICENSE:
+#   Copyright 2012 Joe Miller <https://github.com/joemiller>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+TCP_STATES = {
+  '00' => 'UNKNOWN',  # Bad state ... Impossible to achieve ...
+  'FF' => 'UNKNOWN',  # Bad state ... Impossible to achieve ...
+  '01' => 'ESTABLISHED',
+  '02' => 'SYN_SENT',
+  '03' => 'SYN_RECV',
+  '04' => 'FIN_WAIT1',
+  '05' => 'FIN_WAIT2',
+  '06' => 'TIME_WAIT',
+  '07' => 'CLOSE',
+  '08' => 'CLOSE_WAIT',
+  '09' => 'LAST_ACK',
+  '0A' => 'LISTEN',
+  '0B' => 'CLOSING'
+}
+
+#
+# Netstat TCP Metrics
+#
+class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.tcp"
+
+  option :port,
+         description: 'Port you wish to get metrics for',
+         short: '-p PORT',
+         long: '--port PORT',
+         proc: proc(&:to_i)
+
+  def netstat(protocol = 'tcp') # rubocop:disable all
+    state_counts = Hash.new(0)
+    TCP_STATES.each_pair { |_hex, name| state_counts[name] = 0 }
+
+    # #YELLOW
+    File.open('/proc/net/' + protocol).each do |line| # rubocop:disable Style/Next
+      line.strip!
+      if m = line.match(/^\s*\d+:\s+(.{8}):(.{4})\s+(.{8}):(.{4})\s+(.{2})/) # rubocop:disable AssignmentInCondition
+        connection_state = m[5]
+        connection_port = m[2].to_i(16)
+        connection_state = TCP_STATES[connection_state]
+        if config[:port] && config[:port] == connection_port
+          state_counts[connection_state] += 1
+        elsif !config[:port]
+          state_counts[connection_state] += 1
+        end
+      end
+    end
+    state_counts
+  end
+
+  def run
+    timestamp = Time.now.to_i
+    netstat('tcp').each do |state, count|
+      graphite_name = config[:port] ? "#{config[:scheme]}.#{config[:port]}.#{state}" :
+        "#{config[:scheme]}.#{state}"
+      output "#{graphite_name}", count, timestamp
+    end
+    ok
+  end
+end