sensu-plugins-network-checks 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ce6e609965658347f8c02baa043e102a8f02c2963c01e0bd3e6ec1376da59a
-  data.tar.gz: e8728d260dbcedfe9925ab777bc87dc7135a265a0097fa03a3ebc8d93b8bb420
+  metadata.gz: 9403cddd827516f176d2c6e53e8269e16c407c9dab1cd403dd03f4be819ee9ea
+  data.tar.gz: 43c4090041fb9f1218a6578771b8632221c894a9dbdb8e7f38cc845a8812890c
 SHA512:
-  metadata.gz: 993526dc40bef783d55a7ea7270dce6ae98a99326890dfbc84396f15eb32aa6c18481de783b42dca7421b5c9f13ecdf615eeedfbe8da2427240579a89add5086
-  data.tar.gz: 01b9d44c7164813948a35c2e258c37cf6d7ae2001f105ae7ed710827a9c1e8bce17303907dfb6b752930b9f6c72bff95f3ec9b0aa176597b6af1eabd1e227a14
+  metadata.gz: '0058fc17e30c10c24a204b79894ecc051c91d7e056e7b932807bfe0fa3aee32933fe24e1502bec71fabf5cc2a695e481e3689fe14e9d5bb25e8ebbb873737cf5'
+  data.tar.gz: e70c078cb49a2d5650767874f52c5e2e5f5d33e00fe0e432a3c8ed0db13fc9ad17c1cda46d80a257647b19fb5c8d522c9e88f59f9ced08183eb3f3cffc983163

data/CHANGELOG.md

@@ -4,11 +4,31 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed  [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
+## [5.0.0] 2020-01-26
+### Breaking Changes
+- `metrics-sockstat.rb`: Added hostname to default metric scheme.
+- `metrics-netstat-tcp.rb`: Added support to choose between local and remote port metrics. Defaults to local.  Metric scheme extended to indicate local or remote.
+
+### Added
+- `metrics-interface.rb`: options to include or exclude interfaces via regex. `-X`, `--exclude-interfaces-regex` and `-I`, `--include-interfaces-regex` as alternative to `-x` and `-i`.
+- `check-ports-bind.rb`: Allow to specify the protocol to check for each port individually (address:port/proto)
+
+
+### Changed
+- Updated net-ping runtime dependancy to '2.0.6'
+- Updated rake development dependancy to '~> 12.3'
+- Removed centos build from bonsai.yml
+- Updated whois-parser to ~> 1.2
+- Updated rubocop dependency to '~> 0.79.0'
+- Reconciled issues identified by updating rubocop
+- Updated rake requirement to '~> 13.0'
+- Updated rdoc requirement to '~> 6.2.0'
 
 ## [4.1.1] - 2019-12-18
 ### Changed
 - Updated README to conform with standardization guidelines (sensu-plugins/community#134)
 - Updated bundler development depedency to '~> 2.1'
+- Removed codeclimate development dependency
 
 ## [4.1.0] - 2019-012-12
 ### Added
@@ -250,7 +270,8 @@ This CHANGELOG follows the format listed  [here](https://github.com/sensu-plugin
 
 * initial release, same as community repo
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/4.1.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/5.0.0...HEAD
+[5.0.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/4.1.1...5.0.0
 [4.1.1]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/4.0.0...4.1.1
 [4.1.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/3.2.1...4.0.0

data/bin/check-mtu.rb

@@ -85,5 +85,4 @@ class CheckMTU < Sensu::Plugin::Check::CLI
     ok_message = "#{mtu} matches #{required_mtu}"
     ok ok_message
   end
-  # rubocop:enable Metrics/AbcSize
 end

data/bin/check-multicast-groups.rb

@@ -68,7 +68,7 @@ class CheckMulticastGroups < Sensu::Plugin::Check::CLI
       critical "#{diff.size} missing multicast group(s):\n#{diff_output}"
     end
     ok
-  rescue StandardError => ex
-    critical "Failed to check multicast groups: #{ex}"
+  rescue StandardError => e
+    critical "Failed to check multicast groups: #{e}"
   end
 end

data/bin/check-netfilter-conntrack.rb

@@ -61,7 +61,7 @@ class CheckNetfilterConntrack < Sensu::Plugin::Check::CLI
   def run
     max = nf_conntrack_max
     count = nf_conntrack_count
-    percentage = (count.to_f / max.to_f) * 100
+    percentage = (count / max.to_f) * 100
 
     message "Table is at #{percentage.round(1)}% (#{count}/#{max})"
 

data/bin/check-netstat-tcp.rb

@@ -92,6 +92,7 @@ class CheckNetstatTCP < Sensu::Plugin::Check::CLI
           connection_port = m[2].to_i(16)
           connection_state = TCP_STATES[connection_state]
           next unless config[:states].include?(connection_state)
+
           if config[:port] && config[:port] == connection_port
             state_counts[connection_state] += 1
           elsif !config[:port]

data/bin/check-ports-bind.rb

@@ -23,10 +23,11 @@
 # Ports are comma separated and support ranges
 # ./check-ports.rb -p 127.0.0.1:22,46.20.205.10 --hard --warn
 # ./check-ports.rb -p 127.0.0.1:22,46.20.205.10:80
+# ./check-ports.rb -p 127.0.0.1:22,127.0.0.1:1812/udp,46.20.205.10:389/both
 # If you mention a port without the bind address then the default address is : 0.0.0.0
 #
 # NOTES:
-# By default, checks for openssh on localhost port 22
+# By default, checks for openssh on localhost port 22 (TCP)
 #
 #
 # LICENSE:
@@ -48,11 +49,11 @@ class CheckPort < Sensu::Plugin::Check::CLI
     :hard,
     short: '-d',
     long: '--hard',
-    description: 'Check given ports on both, TCP & UDP',
+    description: 'Check given ports on both, TCP & UDP, if no explicit protocol is set',
     boolean: true,
     default: false
-
   )
+
   option(
     :host,
     short: '-H HOSTNAME',
@@ -65,7 +66,7 @@ class CheckPort < Sensu::Plugin::Check::CLI
     :portbinds,
     short: '-p PORTS',
     long: '--portbinds PORTS',
-    description: 'different address:port to check, comma separated (0.0.0.0:22,localhost:25,127.0.0.0.1:8100-8131,192.168.0.12:3030)',
+    description: 'different address:port/protocol to check, comma separated (0.0.0.0:22,localhost:25/tcp,127.0.0.0.1:8100-8131/udp,192.168.0.12:3030/both)',
     default: '0.0.0.0:22'
   )
 
@@ -99,59 +100,126 @@ class CheckPort < Sensu::Plugin::Check::CLI
   # Severity switcher
   def severity(warn, text)
     if warn
-      warning text.to_s
+      warning(text.to_s)
     else
-      critical text.to_s
+      critical(text.to_s)
     end
   end
 
-  # Check address:port
-  def check_port(portbind, okays)
-    address = portbind.split(':')[0]
-    port = portbind.split(':')[1]
+  # Check valid port number
+  def valid_port?(port)
+    return false unless port =~ /^[0-9]+$/
+
+    (0..65_535).include?(port.to_i)
+  end
+
+  # Check valid port range
+  def valid_port_range?(port)
+    return false unless port =~ /^[0-9]+-[0-9]+$/
+
+    port_start, port_end = port.split('-', 2)
+
+    valid_port?(port_start) && valid_port?(port_end) && port_start.to_i <= port_end.to_i
+  end
+
+  # Ports to check
+  def portbinds
+    default_protocol = config[:hard] ? 'both' : 'tcp'
+    binds = []
+
+    config[:portbinds].split(',').each do |portbind|
+      portbind = "#{config[:host]}:#{portbind}" unless portbind.include?(':')
+      portbind = "#{portbind}/#{default_protocol}" unless portbind.include?('/')
+
+      protocol     = portbind.split('/')[1] || default_protocol
+      address_port = portbind.split('/')[0]
+      address      = address_port.split(':')[0]
+      port         = address_port.split(':')[1]
+
+      if valid_port_range?(port)
+        # Port range
+
+        first_port, last_port = port.split('-', 2)
+        (first_port.to_i..last_port.to_i).each do |p|
+          binds += portbindings(address, p, protocol)
+        end
+      elsif valid_port?(port)
+        # Single port
+
+        binds += portbindings(address, port, protocol)
+      else
+        critical("Invalid port or port range: #{port}")
+      end
+    end
+
+    binds
+  end
+
+  def portbindings(address, port, protocol)
+    if protocol == 'both'
+      [
+        { address: address, port: port, protocol: 'tcp' },
+        { address: address, port: port, protocol: 'udp' }
+      ]
+    else
+      [{ address: address, port: port, protocol: protocol }]
+    end
+  end
+
+  # Portbind hash to string
+  def portbind_to_s(portbind)
+    "#{portbind[:address]}:#{portbind[:port]}/#{portbind[:protocol]}"
+  end
+
+  # Check TCP port
+  def check_tcp_port(portbind, okays)
     Timeout.timeout(config[:timeout]) do
-      connection = TCPSocket.new(address, port.to_i)
+      connection = TCPSocket.new(portbind[:address], portbind[:port])
       p connection if config[:debug]
-      okays.push("TCP-#{portbind}")
+      okays.push(portbind_to_s(portbind))
     end
-    if config[:hard]
-      Timeout.timeout(config[:timeout]) do
-        s = UDPSocket.new
-        s.connect(address, port.to_i)
-        s.close
-        okays.push("UDP-#{portbind}")
-      end
+  end
+
+  # Check UDP port
+  def check_udp_port(portbind, okays)
+    Timeout.timeout(config[:timeout]) do
+      s = UDPSocket.new
+      s.connect(portbind[:address], portbind[:port])
+      s.close
+      okays.push(portbind_to_s(portbind))
+    end
+  end
+
+  # Check address:port/protocol
+  def check_port(portbind, okays)
+    case portbind[:protocol].downcase
+    when 'tcp'
+      check_tcp_port(portbind, okays)
+    when 'udp'
+      check_udp_port(portbind, okays)
+    else
+      severity(config[:warn], "Unsupported protocol #{portbind_to_s(portbind)}")
     end
   rescue Errno::ECONNREFUSED
-    severity(config[:warn], "Connection refused by #{portbind}")
+    severity(config[:warn], "Connection refused by #{portbind_to_s(portbind)}")
   rescue Timeout::Error
-    severity(config[:warn], "Connection or read timed out (#{portbind})")
+    severity(config[:warn], "Connection or read timed out (#{portbind_to_s(portbind)})")
   rescue Errno::EHOSTUNREACH
-    severity(config[:warn], "Check failed to run: No route to host (#{portbind})")
+    severity(config[:warn], "Check failed to run: No route to host (#{portbind_to_s(portbind)})")
   rescue EOFError
-    severity(config[:warn], "Connection closed unexpectedly (#{portbind})")
+    severity(config[:warn], "Connection closed unexpectedly (#{portbind_to_s(portbind)})")
   end
 
   def run
-    portbinds = config[:portbinds].split(',').flat_map do |port_bind|
-      port_bind = "#{config[:host]}:#{port_bind}" unless port_bind.include? ':'
-      # Port range
-      if port_bind.split(',')[1] =~ /^[0-9]+(-[0-9]+)$/
-        first_port, last_port = port_bind.split('-')
-        (first_port.to_i..last_port.to_i).to_a
-        # Single port
-      else
-        port_bind
-      end
-    end
-    array = []
-    portbinds.each do |port|
-      check_port(port, array)
+    ports = portbinds
+    okays = []
+
+    ports.each do |portbind|
+      check_port(portbind, okays)
     end
-    multiplier = 1
-    multiplier = 2 if config[:hard] == true
-    if array.size == portbinds.size * multiplier
-      ok "All ports (#{config[:portbinds]}) are reachable - HARD: #{config[:hard]} => SUCCESS: #{array}"
+
+    if okays.size == ports.size
+      ok "All ports (#{config[:portbinds]}) are reachable: #{okays.join(', ')}"
     else
       severity(config[:warn], 'port count or pattern does not match')
     end

data/bin/metrics-interface.rb

@@ -38,6 +38,16 @@ class InterfaceGraphite < Sensu::Plugin::Metric::CLI::Graphite
          long: '--scheme SCHEME',
          default: "#{Socket.gethostname}.interface"
 
+  option :excludeinterfaceregex,
+         description: 'Regex matching interfaces to exclude',
+         short: '-X INTERFACE',
+         long: '--exclude-interface-regex'
+
+  option :includeinterfaceregex,
+         description: 'Regex matching interfaces to include',
+         short: '-I INTERFACE',
+         long: '--include-interface-regex'
+
   option :excludeinterface,
          description: 'List of interfaces to exclude',
          short: '-x INTERFACE[,INTERFACE]',
@@ -72,9 +82,12 @@ class InterfaceGraphite < Sensu::Plugin::Metric::CLI::Graphite
 
     File.open('/proc/net/dev', 'r').each_line do |line|
       interface, stats_string = line.scan(/^\s*([^:]+):\s*(.*)$/).first
+      next if config[:excludeinterfaceregex] && (interface =~ /#{config[:excludeinterfaceregex]}/)
+      next if config[:includeinterfaceregex] && (interface !~ /#{config[:includeinterfaceregex]}/)
       next if config[:excludeinterface] && config[:excludeinterface].find { |x| line.match(x) }
       next if config[:includeinterface] && !(config[:includeinterface].find { |x| line.match(x) })
       next unless interface
+
       if interface.is_a?(String)
         interface = interface.tr('.', '_')
       end

data/bin/metrics-net.rb

@@ -83,6 +83,7 @@ class LinuxPacketMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
     Dir.glob('/sys/class/net/*').each do |iface_path|
       next if File.file?(iface_path)
+
       iface = File.basename(iface_path)
       next if iface == 'lo'
 

data/bin/metrics-netstat-tcp.rb

@@ -78,6 +78,12 @@ class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
          long: '--port PORT',
          proc: proc(&:to_i)
 
+  option :type,
+         description: 'Specify the type of the port to get metrics for: Local (default)  or remote',
+         short: '-t local|remote',
+         long: '--type local|remote',
+         default: 'local'
+
   option :disabletcp6,
          description: 'Disable tcp6 check',
          short: '-d',
@@ -89,7 +95,13 @@ class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
       line.strip!
       if m = line.match(pattern) # rubocop:disable AssignmentInCondition
         connection_state = m[5]
-        connection_port = m[2].to_i(16)
+        if config[:type] == 'local'
+          connection_port = m[2].to_i(16)
+        elsif config[:type] == 'remote'
+          connection_port = m[4].to_i(16)
+        else
+          unknown "Unknown type level #{config[:type]}. Available values are: local, remote."
+        end
         connection_state = TCP_STATES[connection_state]
         if config[:port] && config[:port] == connection_port
           state_counts[connection_state] += 1
@@ -115,7 +127,7 @@ class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
     end
 
     state_counts.each do |state, count|
-      graphite_name = config[:port] ? "#{config[:scheme]}.#{config[:port]}.#{state}" :
+      graphite_name = config[:port] ? "#{config[:scheme]}.#{config[:port]}.#{config[:type]}.#{state}" :
         "#{config[:scheme]}.#{state}"
       output graphite_name.to_s, count, timestamp
     end

data/bin/metrics-ping.rb

@@ -73,7 +73,7 @@ class PingMetrics < Sensu::Plugin::Metric::CLI::Graphite
 
   OVERVIEW_METRICS = %i[packets_transmitted packets_received packet_loss time].freeze
   STATISTIC_METRICS = %i[min avg max mdev].freeze
-  FLOAT = '(\d+\.\d+)'.freeze
+  FLOAT = '(\d+\.\d+)'
 
   def overview
     @ping.split("\n")[-2].scan(/^(\d+) packets transmitted, (\d+) received, (\d+)% packet loss, time (\d+)ms/)[0]

data/bin/metrics-sockstat.rb

@@ -35,7 +35,7 @@ class MetricsSockstat < Sensu::Plugin::Metric::CLI::Graphite
          description: 'Metric naming scheme, text to prepend to $protocol.$field',
          long: '--scheme SCHEME',
          short: '-s SCHEME',
-         default: 'network.sockets'
+         default: "#{Socket.gethostname}.network.sockets"
 
   def output_metric(name, value)
     output "#{@config[:scheme]}.#{name} #{value} #{@timestamp}"
@@ -55,7 +55,7 @@ class MetricsSockstat < Sensu::Plugin::Metric::CLI::Graphite
   end
 
   def read_sockstat
-    return IO.read('/proc/net/sockstat')
+    IO.read('/proc/net/sockstat')
   rescue StandardError => e
     unknown "Failed to read /proc/net/sockstat: #{e}"
   end

data/lib/sensu-plugins-network-checks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-network-checks
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: net-ping
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.8
+        version: 2.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.8
+        version: 2.0.6
 - !ruby/object:Gem::Dependency
   name: whois
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement