network-monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9b8eec6e627acd02076903b075f725f921cfa02
+  data.tar.gz: 354895adda561dec4b12ae759ab823f84fc644ae
+SHA512:
+  metadata.gz: aa723ac94362ea32fe7ad661ddb6b0d72885a27661a3ab921a520dc22222b0cf2f3c86a1a4215d4291a2789d26385d8897b854e84a3160fa1c4370e53a857fd7
+  data.tar.gz: a912d1f63af9d9b3bbf28bec2c7d6746a7bad5145ddcebd7a38ba14bf0675d5f6cf483e0e93f688470e0453136dc3f16c44745d6c18039443e6a156755159038

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in network-monitor.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# Network::Monitor
+
+`Network::Monitor` is a simple script to measure network utilisation and error rates on SNMP capable network hardware.
+
+**This is an old project which I've migrated to a gem. It probably needs a lot more work**
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install network-monitor
+
+## Usage
+
+Create a `hosts.conf` file which includes all the IP addresses of your networking hardware, e.g. switches, wireless routers, etc:
+
+	  - '10.0.0.1'
+	  - '10.0.0.10'
+	  - '10.0.0.30'
+	  - '10.0.0.31'
+	  - '10.0.0.32'
+
+Then run `network-monitor`:
+
+	$ network-monitor --hosts path/to/hosts.conf
+	                   Utilization Report @ 2014-05-14 20:28:38 +1200                   
+	                                  Errors Detected                                   
+	           10.0.0.10:    2      IN#      57 OUT#       0
+	           10.0.0.10:    3      IN#      32 OUT#       0
+	           10.0.0.30:    2      IN#     847 OUT#       0
+	           10.0.0.32:    2      IN#     120 OUT#       0
+	                              17 ports not displayed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2014, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/network-monitor

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# monitor.rb - a simple script to monitor SNMP port status and utilization
+# Copyright (c) 2008 Samuel Williams. Released under the GNU GPLv3.
+
+require 'trollop'
+
+require_relative '../lib/network/monitor'
+
+opts = Trollop::options do
+	opt :database, "Path to sqlite3 database", :type => String, :default => "ports.sqlite3"
+	opt :delay, "The delay between subsequent checks", :type => Float, :default => 10.0
+	opt :hosts, "The hosts configuration file", :type => String, :default => "hosts.conf"
+end
+
+$hosts = YAML::load_file(opts[:hosts])
+
+ActiveRecord::Base.establish_connection(
+:adapter => 'sqlite3',
+:database  => opts[:database]
+)
+
+unless File.exist? opts[:database]
+	Network::Monitor.migrate_database!
+end
+
+# Currently unused, but gets names from hardware if possible:
+def fetch_names(hosts)
+	puts "Fetching names..."
+	hosts.each do |h|
+		SNMP::Manager.open(:Host => h, :Version => :SNMPv1) do |manager|
+			response = manager.get(["sysDescr.0", "sysName.0"])
+      
+			name = response.varbind_list[1].value.to_s + ' (' + response.varbind_list[0].value.to_s + ')'
+      
+			$names[h] = name
+		end
+	end
+	puts "Done."
+end
+
+begin
+	while true
+		start_time = Time.now
+	
+		$hosts.each do |host|
+			begin
+				Network::Monitor::Interface.query(host)
+			rescue SNMP::RequestTimeout
+				$stderr.puts "#{host}: Timed out when requesting SNMP data..."
+			rescue Errno::EHOSTUNREACH
+				$stderr.puts "#{host}: Error - host unreachable!"
+			rescue Errno::EHOSTDOWN
+				$stderr.puts "#{host}: Error - host unreachable!"
+			end
+		end
+	
+		puts
+		Network::Monitor::Interface.print_statistics($stdout)
+	
+		end_time = Time.now
+	
+		duration = end_time - start_time
+		sleep(opts[:delay] - duration) if duration < opts[:delay]
+	end
+rescue Interrupt
+	puts "Exiting..."
+end

data/lib/network/monitor.rb

@@ -0,0 +1,10 @@
+
+require_relative "monitor/interface"
+require_relative "monitor/schema"
+require_relative "monitor/version"
+
+module Network
+	module Monitor
+		
+	end
+end

data/lib/network/monitor/interface.rb

@@ -0,0 +1,140 @@
+
+require 'snmp'
+require 'active_record'
+
+require 'rainbow'
+
+module Network
+	module Monitor
+		class Interface < ActiveRecord::Base
+			QueryColumns = ["ifIndex", "ifSpeed", "ifInOctets", "ifInErrors", "ifOutOctets", "ifOutErrors"]
+
+			def self.hosts
+				Interface.all.group("host").collect { |r| r.host }
+			end
+
+			def self.query(host)
+				SNMP::Manager.open(:Host => host, :Version => :SNMPv1) do |manager|
+					manager.walk(QueryColumns) do |row|
+						next if row[1].value.to_i == 0 # Speed of interface is reported as 0 by some faulty equipment, ignore these ports.
+
+						record = Interface.new(:host => host)
+
+						QueryColumns.each_with_index do |c,i|
+							record.send("#{c}=", row[i].value.to_i)
+						end
+
+						record.save!
+					end
+				end
+			end
+
+			def statistics(prev)
+				dt = (created_at - prev.created_at).to_f
+				s = {
+					:startTime => prev.created_at,
+					:endTime => created_at,
+					:timePeriod => created_at - prev.created_at,
+					:ifInOctets => ifInOctets - prev.ifInOctets,
+					:ifOutOctets => ifOutOctets - prev.ifOutOctets,
+					:ifInErrors => ifInErrors - prev.ifInErrors,
+					:ifOutErrors => ifOutErrors - prev.ifOutErrors
+				}
+
+				# Counter32 may wrap and produce strange results unless we deal with it..
+				[:ifInOctets, :ifOutOctets, :ifInErrors, :ifOutErrors].each do |c|
+					if s[c] < 0
+						s[c] = Counter32Max + s[c]
+					end
+				end
+
+				s[:ifInUsage] = (s[:ifInOctets].to_f * 8.0) / (ifSpeed.to_f * dt)
+				s[:ifOutUsage] = (s[:ifOutOctets].to_f * 8.0) / (ifSpeed.to_f * dt)
+
+				return s
+			end
+
+			def speed_string
+				bits_to_string(ifSpeed.to_i)
+			end
+
+			def previous
+				Interface.where("host = ? and ifIndex = ? and id < ?", host, ifIndex, id).limit(1).order("created_at desc").first
+			end
+
+			def self.print_statistics(out, min = 0.01)
+				unused_count = 0
+
+				error_interfaces = []
+
+				out.puts "Utilization Report @ #{Time.now.to_s}".center(84)
+				Interface.all.group("host, ifIndex").each do |iface|
+					r2, r1 = Interface.where("host = ? and ifIndex = ?", iface.host, iface.ifIndex).limit(2).order("created_at desc").to_a
+
+					next if r1 == nil or r2 == nil
+
+					unused = true
+					name = iface.host
+
+					s = r2.statistics(r1)
+      
+					if s[:ifInErrors] > 0 or s[:ifOutErrors] > 0
+						error_interfaces << [iface, name, s]
+						unused = false
+					end
+      
+					if s[:ifInUsage] > min or s[:ifOutUsage] > min
+						out.print "#{name.rjust(20)}: #{iface.ifIndex.to_s.rjust(4)}    "
+
+						[[:ifInUsage, "IN%"], [:ifOutUsage, "OUT%"]].each do |v|
+							key, name = *v
+          
+							out.print name.rjust(8)
+							out.print s[key].to_prs.rjust(8)
+						end
+						out.puts r1.speed_string.rjust(10)
+        
+						unused = false
+					end
+      
+					unused_count += 1 if unused
+				end
+    
+				if error_interfaces.size > 0
+					out.puts "Errors Detected".center(84)
+					error_interfaces.each do |r|
+						iface, name, s = r
+        
+						out.print "#{name.rjust(20)}: #{iface.ifIndex.to_s.rjust(4)}    "
+        
+						[[:ifInErrors, "IN\#"], [:ifOutErrors, "OUT\#"]].each do |v|
+							key, name = v
+          
+							out.print name.rjust(5)
+							out.print s[key].to_s.rjust(8)
+						end
+        
+						out.puts
+					end
+				end
+    
+				out.puts "#{unused_count} ports not displayed.".center(84)
+			end
+			
+			private
+			
+			def bits_to_string(size)
+				human_size = size
+				levels = 0
+  
+				while human_size >= 1000
+					human_size /= 1000.0
+					levels += 1
+				end
+  
+				#maybe localize this?    
+				sprintf("%0.1f%s", human_size, ['', 'K', 'M', 'G', 'T', 'X'].fetch(levels)) + 'b'
+			end
+		end
+	end
+end

data/lib/network/monitor/network_statistics.rb

@@ -0,0 +1,200 @@
+
+require 'rubygems'
+gem 'snmp'
+
+require 'snmp'
+require 'active_record'
+
+Counter32Max = 4294967295
+
+OPTIONS = {
+  :PostLog => true,
+  :Duration => 10,
+  :DatabaseFile => "ports.db",
+  :HostsFile => "hosts.conf"
+}
+
+class Float
+  def to_prs
+    return sprintf("%0.2f\%", self * 100.0)
+  end
+end
+
+def bits_to_string(size)
+  human_size = size
+  levels = 0
+  
+  while human_size >= 1000
+    human_size /= 1000.0
+    levels += 1
+  end
+  
+  #maybe localize this?    
+  sprintf("%0.1f%s", human_size, ['', 'K', 'M', 'G', 'T', 'X'].fetch(levels)) + 'b'
+end
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database  => OPTIONS[:DatabaseFile]
+)
+
+unless File.exists? OPTIONS[:DatabaseFile]
+  puts "Building new database..."
+  
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :interfaces do |t|
+      t.string :host, :null => false
+      t.integer :ifIndex, :null => false
+
+      t.integer :ifSpeed, :null => false
+
+      t.integer :ifInOctets, :null => false
+      t.integer :ifOutOctets, :null => false
+
+      t.integer :ifInErrors, :null => false
+      t.integer :ifOutErrors, :null => false
+
+      t.datetime :created_at
+    end
+    
+    change_table :interfaces do |t|
+      t.index :host
+      t.index :ifIndex
+#      t.index :created_at
+    end
+  end
+end
+
+Counters = ["ifInOctets", "ifInErrors", :ifInUtilization, "ifOutOctets", "ifOutErrors", :ifOutUtilization]
+
+$names = {}
+
+def fetch_names(hosts)
+  puts "Fetching names..."
+  hosts.each do |h|
+    SNMP::Manager.open(:Host => h, :Version => :SNMPv1) do |manager|
+      response = manager.get(["sysDescr.0", "sysName.0"])
+      
+      name = response.varbind_list[1].value.to_s + ' (' + response.varbind_list[0].value.to_s + ')'
+      
+      $names[h] = name
+    end
+  end
+  puts "Done."
+end
+
+class Interface < ActiveRecord::Base
+  QueryColumns = ["ifIndex", "ifSpeed", "ifInOctets", "ifInErrors", "ifOutOctets", "ifOutErrors"]
+  
+  def self.hosts
+    Interface.all.group("host").collect { |r| r.host }
+  end
+  
+  def self.query(host)
+    SNMP::Manager.open(:Host => host, :Version => :SNMPv1) do |manager|
+      manager.walk(QueryColumns) do |row|
+        next if row[1].value.to_i == 0 # Speed of interface is reported as 0 by some faulty equipment, ignore these ports.
+        
+        record = Interface.new(:host => host)
+        
+        QueryColumns.each_with_index do |c,i|
+           record.send("#{c}=", row[i].value.to_i)
+        end
+        
+        record.save!
+      end
+    end
+  end
+  
+  def statistics(prev)
+    dt = (created_at - prev.created_at).to_f
+    s = {
+      :startTime => prev.created_at,
+      :endTime => created_at,
+      :timePeriod => created_at - prev.created_at,
+      :ifInOctets => ifInOctets - prev.ifInOctets,
+      :ifOutOctets => ifOutOctets - prev.ifOutOctets,
+      :ifInErrors => ifInErrors - prev.ifInErrors,
+      :ifOutErrors => ifOutErrors - prev.ifOutErrors
+    }
+    
+    # Counter32 may wrap and produce strange results unless we deal with it..
+    [:ifInOctets, :ifOutOctets, :ifInErrors, :ifOutErrors].each do |c|
+      if s[c] < 0
+        s[c] = Counter32Max + s[c]
+      end
+    end
+    
+    s[:ifInUsage] = (s[:ifInOctets].to_f * 8.0) / (ifSpeed.to_f * dt)
+    s[:ifOutUsage] = (s[:ifOutOctets].to_f * 8.0) / (ifSpeed.to_f * dt)
+    
+    return s
+  end
+  
+  def speed_string
+    bits_to_string(ifSpeed.to_i)
+  end
+  
+  def previous
+    Interface.where("host = ? and ifIndex = ? and id < ?", host, ifIndex, id).limit(1).order("created_at desc").first
+  end
+  
+  def self.print_statistics(out, min = 0.01)
+    unused_count = 0
+    
+    error_interfaces = []
+    
+    out.puts "Utilization Report @ #{Time.now.to_s}".center(84)
+    Interface.all.group("host, ifIndex").each do |iface|
+      r2, r1 = Interface.where("host = ? and ifIndex = ?", iface.host, iface.ifIndex).limit(2).order("created_at desc").to_a
+      
+      next if r1 == nil or r2 == nil
+
+      unused = true
+      name = $names[iface.host] || iface.host
+
+      s = r2.statistics(r1)
+      
+      if s[:ifInErrors] > 0 or s[:ifOutErrors] > 0
+        error_interfaces << [iface, name, s]
+        unused = false
+      end
+      
+      if s[:ifInUsage] > min or s[:ifOutUsage] > min
+        out.print "#{name.rjust(20)}: #{iface.ifIndex.to_s.rjust(4)}    "
+
+        [[:ifInUsage, "IN%"], [:ifOutUsage, "OUT%"]].each do |v|
+          key, name = *v
+          
+          out.print name.rjust(8)
+          out.print s[key].to_prs.rjust(8)
+        end
+        out.puts r1.speed_string.rjust(10)
+        
+        unused = false
+      end
+      
+      unused_count += 1 if unused
+    end
+    
+    if error_interfaces.size > 0
+      out.puts "Errors Detected".center(84)
+      error_interfaces.each do |r|
+        iface, name, s = r
+        
+        out.print "#{name.rjust(20)}: #{iface.ifIndex.to_s.rjust(4)}    "
+        
+        [[:ifInErrors, "IN\#"], [:ifOutErrors, "OUT\#"]].each do |v|
+          key, name = v
+          
+          out.print name.rjust(5)
+          out.print s[key].to_s.rjust(8)
+        end
+        
+        out.puts
+      end
+    end
+    
+    out.puts "#{unused_count} ports not displayed.".center(84)
+  end
+end

data/lib/network/monitor/schema.rb

@@ -0,0 +1,27 @@
+
+module Network
+	module Monitor
+		def self.migrate_database!
+			ActiveRecord::Schema.define(:version => 1) do
+				create_table :interfaces do |t|
+					t.string :host, :null => false
+					t.integer :ifIndex, :null => false
+
+					t.integer :ifSpeed, :null => false
+
+					t.integer :ifInOctets, :null => false
+					t.integer :ifOutOctets, :null => false
+
+					t.integer :ifInErrors, :null => false
+					t.integer :ifOutErrors, :null => false
+
+					t.datetime :created_at
+	  
+					t.index :host
+					t.index :ifIndex
+					t.index :created_at
+				end
+			end
+		end
+	end
+end

data/lib/network/monitor/version.rb

@@ -0,0 +1,5 @@
+module Network
+  module Monitor
+    VERSION = "0.1.0"
+  end
+end

data/network-monitor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'network/monitor/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "network-monitor"
+	spec.version       = Network::Monitor::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.summary       = %q{A tool for monitoring network ports for both throughput and errors.}
+	spec.homepage      = ""
+	spec.license       = "MIT"
+	
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency "snmp", "~> 1.1.1"
+	spec.add_dependency "trollop", "~> 2.0.0"
+	
+	spec.add_dependency "rainbow", '~> 2.0.0'
+	
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: network-monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables:
+- network-monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/network-monitor
+- lib/network/monitor.rb
+- lib/network/monitor/interface.rb
+- lib/network/monitor/network_statistics.rb
+- lib/network/monitor/schema.rb
+- lib/network/monitor/version.rb
+- network-monitor.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A tool for monitoring network ports for both throughput and errors.
+test_files: []