sensu-plugins-network-interface 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d710020eee74c6f67f4ddffb54681fa8a082c1f9
+  data.tar.gz: bf2a2743f08bf6c8bda1eecd960609ac8d0feb39
+SHA512:
+  metadata.gz: ffb0511ef45a42c56a70573202dba316ae93139c32bac27c6f6c929b7704968317e1e8c32b57bca6177046ec51f5f826faab5d45044eb65517a4ad08fa3b006c
+  data.tar.gz: 25b55835363f9bada8a9ea6d7dac184e87dd100d210db1a6f6ede965cd0e222d93e895c101b48d389299c770c0b7c0265f6ea888b5f04d0e206ae8ea93e5db80

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased
+
+## [0.0.1] - 2015-12-28
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+MIT License
+
+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,52 @@
+# Sensu plugin for monitoring network interfaces
+
+A sensu plugin to efficiently monitor network interfaces on Linux allowing to track metrics like speed, duplex, operational status, link carrier etc.
+
+The plugin generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input) so that you
+do not miss state changes when monitoring multiple interfaces + metrics.
+
+## Usage
+
+The plugin accepts command line options to specify things like expected mtu, speed, duplex, operstate etc.
+
+```
+Usage: check-network-interface.rb (options)
+        --carrier <STATE>            Indicates the current physical link state of the interface (default: up)
+    -c, --config <PATH>              Optional configuration file (default: ./network-interface.json)
+    -d, --duplex <STATE>             Check interface duplex settings (default: full)
+    -x <INTERFACES>                  Comma separated list of interfaces to ignore
+    -i <INTERFACES>                  Comma separated list of interfaces to check (default: ALL)
+    -m, --mtu <MTU>                  Message Transfer Unit
+        --operstate <STATE>          Indicates the interface RFC2863 operational state (default: up)
+    -X <INTERFACES>                  Comma separated list of Interfaces to ignore (regex)
+    -I <INTERFACES>                  Comma separated list of interfaces to check (regex)
+    -s, --speed <SPEED>              Expected speed in Mb/s
+    -t, --txqueuelen <TXQUEUELEN>    Transmit Queue Length
+    -w, --warn                       Warn instead of throwing a critical failure
+```
+
+By default, command line option parameters are global to all interfaces. However, each interface can override the defaults in an optional JSON configuration file which must be placed
+in the same location as the plugin.
+
+JSON example:
+
+```
+{
+  "interfaces": {
+    "eth0": {
+      "operstate": "down",
+      "carrier": "down"
+      "duplex": "full",
+      "speed": 10000,
+      "mtu": 9000,
+      "txqueuelen": 10000
+    },
+    ...
+  }
+}
+```
+
+Ideally, you would manage the configuration file via your favourite cfgmgmt tool (e.g. Puppet).
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-network-interface.rb

@@ -0,0 +1,243 @@
+#!/usr/bin/env ruby
+#
+# check-network-interface.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'socket'
+
+class CheckNetworkInterface < Sensu::Plugin::Check::CLI
+  option :interface,
+         :description => "Comma separated list of interfaces to check (default: ALL)",
+         :short => "-i <INTERFACES>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :rinterface,
+         :description => "Comma separated list of interfaces to check (regex)",
+         :short => "-I <INTERFACES>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_interface,
+         :description => "Comma separated list of interfaces to ignore",
+         :short => "-x <INTERFACES>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :rignore_interface,
+         :description => "Comma separated list of Interfaces to ignore (regex)",
+         :short => "-X <INTERFACES>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :config_file,
+         :description => "Optional configuration file (default: #{File.dirname(__FILE__)}/network-interface.json)",
+         :short => "-c <PATH>",
+         :long => "--config <PATH>",
+         :default => File.dirname(__FILE__) + "/network-interface.json"
+
+  option :speed,
+         :description => "Expected speed in Mb/s",
+         :short => "-s <SPEED>",
+         :long => "--speed <SPEED>",
+         :proc => proc(&:to_i),
+         :default => nil
+
+  option :mtu,
+         :description => 'Message Transfer Unit',
+         :short => "-m <MTU>",
+         :long => "--mtu <MTU>",
+         :proc => proc(&:to_i),
+         :default => nil
+
+  option :txqueuelen,
+         :description => 'Transmit Queue Length',
+         :short => "-t <TXQUEUELEN>",
+         :long => "--txqueuelen <TXQUEUELEN>",
+         :proc => proc(&:to_i),
+         :default => nil
+
+  option :duplex,
+         :description => "Check interface duplex settings (default: full)",
+         :short => "-d <STATE>",
+         :long => "--duplex <STATE>",
+         :in => ["half", "full"],
+         :default => "full"
+
+  option :operstate,
+         :description => "Indicates the interface RFC2863 operational state (default: up)",
+         :long => "--operstate <STATE>",
+         :in => ["unknown", "notpresent", "down", "lowerlayerdown", "testing", "dormant", "up"],
+         :default => "up"
+
+  option :carrier,
+         :description => "Indicates the current physical link state of the interface (default: up)",
+         :long => "--carrier <STATE>",
+         :in => ["down", "up"],
+         :default => "up"
+
+  option :warn,
+         :description => "Warn instead of throwing a critical failure",
+         :short => "-w",
+         :long => "--warn",
+         :boolean => false
+
+  def initialize()
+    super
+
+    @interfaces = []
+    find_interfaces().each do |interface|
+      if config[:ignore_interface].size > 0
+        next if config[:ignore_interface].include?(interface)
+      end
+
+      if config[:rignore_interface].size > 0
+        b = false
+        config[:rignore_interface].each do |ignore_interface|
+          if interface =~ Regexp.new(ignore_interface)
+            b = true
+            break
+          end
+        end
+        next if b
+      end
+
+      if config[:interface].size > 0
+        next unless config[:interface].include?(interface)
+      end
+
+      if config[:rinterface].size > 0
+        b = true
+        config[:rinterface].each do |rinterface|
+          if interface =~ Regexp.new(rinterface)
+            b = false
+            break
+          end
+        end
+        next if b
+      end
+
+      @interfaces << interface
+    end
+
+    @json_config = nil
+    if File.exists?(config[:config_file])
+      require 'json'
+      @json_config = JSON.parse(File.read(config[:config_file]))
+    end
+  end
+
+  def send_client_socket(data)
+    sock = UDPSocket.new
+    sock.send(data + "\n", 0, "127.0.0.1", 3030)
+  end
+
+  def send_ok(check_name, msg)
+    event = {"name" => check_name, "status" => 0, "output" => "OK: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, msg)
+    event = {"name" => check_name, "status" => 1, "output" => "WARNING: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, msg)
+    event = {"name" => check_name, "status" => 2, "output" => "CRITICAL: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, msg)
+    event = {"name" => check_name, "status" => 3, "output" => "UNKNOWN: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def find_interfaces()
+    Dir["/sys/class/net/*"].map { |i| File.basename(i) }.reject { |i| i =~ /^lo/ }
+  end
+
+  def get_info(interface)
+    info = {}
+
+    # https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-class-net
+    ["tx_queue_len", "speed", "mtu", "duplex", "carrier", "operstate"].each do |metric|
+      if File.exists?("/sys/class/net/#{interface}/#{metric}")
+        value = File.read("/sys/class/net/#{interface}/#{metric}").chomp
+
+        case metric
+          when "speed", "mtu"
+            info[metric] = value.to_i
+
+          when "tx_queue_len"
+            info['txqueuelen'] = value.to_i
+
+          when "carrier"
+            info[metric] = value.to_i > 0 ? "up" : "down"
+
+          else
+            info[metric] =  value
+        end
+      else
+        info[metric] = nil
+      end
+    end
+
+    info
+  end
+
+  def run
+    problems = 0
+
+    @interfaces.each do |interface|
+      get_info(interface).each do |metric, value|
+        check_name = "network-interface-#{interface}-#{metric}"
+
+        if value != nil
+          if @json_config.has_key?('interfaces') and @json_config['interfaces'].has_key?(interface) and @json_config['interfaces'][interface].has_key?(metric)
+            if value != @json_config['interfaces'][interface][metric]
+              msg = "Expected #{metric} #{@json_config['interfaces'][interface][metric]} but found #{value} on #{interface}"
+              if config[:warn]
+                send_warning(check_name, msg)
+              else
+                send_critical(check_name, msg)
+              end
+              problems += 1
+            else
+              send_ok(check_name, "Found expected #{metric} (#{@json_config['interfaces'][interface][metric]}) on #{interface}")
+            end
+          else
+            if config[metric.to_sym] != nil
+              if value != config[metric.to_sym]
+                msg = "Expected #{metric} #{config[metric.to_sym]} but found #{value} on #{interface}"
+                if config[:warn]
+                  send_warning(check_name, msg)
+                else
+                  send_critical(check_name, msg)
+                end
+                 problems += 1
+              else
+                send_ok(check_name, "Found expected #{metric} (#{config[metric.to_sym]}) on #{interface}")
+              end
+            else
+              send_ok(check_name, "#{metric} #{interface}")
+            end
+          end
+        else
+          send_unknown(check_name, "Failed to look up #{metric} on #{interface}")
+          problems += 1
+        end
+      end
+    end
+
+    if problems > 0
+      message "Found #{problems} problems"
+      warning if config[:warn]
+      critical
+    else
+      ok "All interfaces (#{@interfaces.join(', ')}) are matching the specified settings"
+    end
+  end
+end

data/bin/network-interface.json.example

@@ -0,0 +1,26 @@
+{
+  "interfaces": {
+    "eth0": {
+      "operstate": "down",
+      "carrier": "down"
+    },
+    "eth1": {
+      "operstate": "down",
+      "carrier": "down"
+    },
+    "eth2": {
+      "operstate": "up",
+      "carrier": "up",
+      "speed": 10000,
+      "mtu": 9000,
+      "txqueuelen": 10000
+    },
+    "eth3": {
+      "operstate": "up",
+      "carrier": "up",
+      "speed": 10000,
+      "mtu": 9000,
+      "txqueuelen": 10000
+    }
+  }
+}

data/lib/sensu-plugins-network-interface.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-network-interface/version'

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

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-network-interface
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-28 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: This plugin provides facilities to monitoring network interfaces on Linux
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-network-interface.rb
+- network-interface.json.example
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-network-interface.rb
+- bin/network-interface.json.example
+- lib/sensu-plugins-network-interface.rb
+- lib/sensu-plugins-network-interface/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-network-interface
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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 plugins for monitoring network interfaces on Linux
+test_files: []