arborist-snmp 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 833fc064ac6b821016f02ec2b427c7861cc4ebd2
-  data.tar.gz: d14a89c993c13e874b9201388999bb77ac85c06f
+SHA256:
+  metadata.gz: 1249bdfdca3585ad83e5257085356af249e49ddd5691d1e5b8cd77f792c81c9a
+  data.tar.gz: 3b85bd63b62caa5554ee76f3737556b07e970999cc7ddf0153fd51169e4b7e54
 SHA512:
-  metadata.gz: be00731e69eae712e71e9881abb20ba9d1393de4acad424b8b2c7225b95d351e211a9c20551556f76fde34e59a551ff2716f9f220a247afa35b529b688301ca5
-  data.tar.gz: bd6b4d1292adec637932fc8edccd62fe1db5fbaea2350995ab9c504e2eb002e36470ca7280742fb9b4eb231523fc8744bcb0d5135017bdf4bae8e23c8d5757bd
+  metadata.gz: 61a8a588eb87e99848c41c312b3eaa690a4c65ffb13d565266f89bdb850790822d5ea26132e69e26133f5bfae1eb5ed4e57c7bbd0f06c52d9d0dacc034c1d115
+  data.tar.gz: bfd1b4c4b1d7feb5c6b1726f4c73748d0e357a27983f69c8441a5882495d9d725dc04bab7550da22827fd1a7fe3316f703dc75e409fef7d048f5a9847aa243c3

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+)� ���1��v�Fe��W�o*���O�Q��{4��@��"ԅ�|���!Tڱ���t&@V0�?jm_�P�`����{[�Z��u�q/y��Y���=����K�N�L�J���5�]ː6�\Nω�Z�SNKkv�2d6���L-�+T?�^�z��_��o�ݏ��7�b�d)��k

data/lib/arborist/monitor/snmp.rb

@@ -3,7 +3,7 @@
 #encoding: utf-8
 
 require 'arborist/monitor' unless defined?( Arborist::Monitor )
-require 'net-snmp2'
+require 'netsnmp'
 
 # SNMP checks for Arborist.  Requires an SNMP agent to be installed
 # on target machine, and the various "pieces" enabled for your platform.
@@ -38,13 +38,6 @@ module Arborist::Monitor::SNMP
 		setting :batchsize, default: 25
 	end
 
-	# Indicate to FFI that we're using threads.
-	Net::SNMP.thread_safe = true
-
-
-	# The system type, as advertised.
-	attr_reader :system
-
 	# The mapping of addresses back to node identifiers.
 	attr_reader :identifiers
 
@@ -64,7 +57,7 @@ module Arborist::Monitor::SNMP
 		nodes.each_pair do |(identifier, props)|
 			next unless props.key?( 'addresses' )
 			address = props[ 'addresses' ].first
-			self.identifiers[ address ] = [ identifier, props['config'] ]
+			self.identifiers[ address ] = [ identifier, props ]
 		end
 
 		# Perform the work!
@@ -86,7 +79,7 @@ module Arborist::Monitor::SNMP
 				thr = Thread.new do
 					config = self.identifiers[ host ].last || {}
 					opts = {
-						peername:  host,
+						host:      host,
 						port:      config[ 'port' ]      || Arborist::Monitor::SNMP.port,
 						version:   config[ 'version' ]   || Arborist::Monitor::SNMP.version,
 						community: config[ 'community' ] || Arborist::Monitor::SNMP.community,
@@ -94,22 +87,17 @@ module Arborist::Monitor::SNMP
 						retries:   config[ 'retries' ]   || Arborist::Monitor::SNMP.retries
 					}
 
-					snmp = Net::SNMP::Session.open( opts )
 					begin
-						@system = snmp.get( IDENTIFICATION_OID ).varbinds.first.value
-						yield( host, snmp )
+						NETSNMP::Client.new( opts ) do |snmp|
+							Thread.current[ :system ] = snmp.get( oid: IDENTIFICATION_OID )
+							yield( host, snmp )
+						end
 
-					rescue Net::SNMP::TimeoutError, Net::SNMP::Error => err
-						self.log.error "%s: %s %s" % [ host, err.message, snmp.error_message ]
-						self.results[ host ] = {
-							error: "%s" % [ snmp.error_message ]
-						}
 					rescue => err
+						self.log.error "%s: %s\n%s" % [ host, err.message, err.backtrace.join("\n  ") ]
 						self.results[ host ] = {
-							error: "Uncaught exception. (%s: %s)" % [ err.class.name, err.message ]
+							error: "Exception (%s: %s)" % [ err.class.name, err.message ]
 						}
-					ensure
-						snmp.close
 					end
 				end
 
@@ -135,10 +123,18 @@ module Arborist::Monitor::SNMP
 		@results     = {}
 	end
 
+
+	### Return the current SNMP connection system string.
+	def system
+		return Thread.current[ :system ]
+	end
+
 end # Arborist::Monitor::SNMP
 
 require 'arborist/monitor/snmp/cpu'
 require 'arborist/monitor/snmp/disk'
 require 'arborist/monitor/snmp/process'
 require 'arborist/monitor/snmp/memory'
+require 'arborist/monitor/snmp/ups'
+require 'arborist/monitor/snmp/ups/battery'
 

data/lib/arborist/monitor/snmp/cpu.rb

@@ -24,11 +24,7 @@ class Arborist::Monitor::SNMP::CPU
 	# When walking load OIDS, the iterator count matches
 	# these labels.
 	#
-	LOADKEYS = {
-		1 => :load1,
-		2 => :load5,
-		3 => :load15
-	}
+	LOADKEYS = %i[ load1 load5 load15 ]
 
 
 	# Global defaults for instances of this monitor
@@ -66,18 +62,13 @@ class Arborist::Monitor::SNMP::CPU
 	protected
 	#########
 
-	### Return system CPU data.
-	###
-	def cpu( snmp )
-		return snmp.walk( OIDS[:cpu] )
-	end
-
-
 	### Find load data, add additional niceties for reporting.
 	###
 	def format_load( snmp )
 		info = { cpu: {}, load: {} }
-		cpus = self.cpu( snmp )
+		cpus = snmp.walk( oid: OIDS[:cpu] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
 
 		info[ :cpu ][ :count ] = cpus.size
 
@@ -91,20 +82,21 @@ class Arborist::Monitor::SNMP::CPU
 		# alert after X events" pragmas.
 		#
 		if self.system =~ /windows\s+/i
-			info[ :cpu ][ :usage ] = cpus.values.inject( :+ ).to_f / cpus.size
+			info[ :cpu ][ :usage ] = cpus.inject( :+ ).to_f / cpus.size
 			info[ :message ] = "System is %0.1f%% in use." % [ info[ :cpu ][ :usage ] ]
 
+
 		# UCDavis stuff is better for alerting only after there has been
 		# an extended load event.  Use the 5 minute average to avoid
 		# state changes on transient spikes.
 		#
 		else
-			snmp.walk( OIDS[:load] ).each_with_index do |(_, value), idx|
-				next unless LOADKEYS[ idx + 1 ]
-				info[ :load ][ LOADKEYS[idx + 1] ] = value.to_f
+			snmp.walk( oid: OIDS[:load] ).each_with_index do |(_, value), idx|
+				next unless LOADKEYS[ idx ]
+				info[ :load ][ LOADKEYS[idx] ] = value.to_f
 			end
 
-			percentage = (( ( info[:load][ :load5 ] / cpus.size ) - 1 ) * 100 ).round( 1 )
+			percentage = (( ( info[:load][ :load5 ] / cpus.size) - 1 ) * 100 ).round( 1 )
 
 			if percentage < 0
 				info[ :message ] = "System is %0.1f%% idle." % [ percentage.abs ]
@@ -125,7 +117,7 @@ class Arborist::Monitor::SNMP::CPU
 	def find_load( host, snmp )
 		info = self.format_load( snmp )
 
-		config  = identifiers[ host ].last || {}
+		config  = self.identifiers[ host ].last['config'] || {}
 		warn_at = config[ 'warn_at' ] || self.class.warn_at
 		usage   = info.dig( :cpu, :usage ) || 0
 

data/lib/arborist/monitor/snmp/disk.rb

@@ -17,9 +17,10 @@ class Arborist::Monitor::SNMP::Disk
 	# OIDS required to pull disk information from net-snmp.
 	#
 	STORAGE_NET_SNMP = {
-		path: '1.3.6.1.4.1.2021.9.1.2',
+		path:    '1.3.6.1.4.1.2021.9.1.2',
 		percent: '1.3.6.1.4.1.2021.9.1.9',
-		type: '1.3.6.1.2.1.25.3.8.1.4'
+		type:    '1.3.6.1.2.1.25.3.8.1.4',
+		access:  '1.3.6.1.2.1.25.3.8.1.5'
 	}
 
 	# The OID that matches a local windows hard disk.
@@ -32,15 +33,21 @@ class Arborist::Monitor::SNMP::Disk
 	# OIDS required to pull disk information from Windows.
 	#
 	STORAGE_WINDOWS = {
-		type: '1.3.6.1.2.1.25.2.3.1.2',
-		path: '1.3.6.1.2.1.25.2.3.1.3',
+		type:  '1.3.6.1.2.1.25.2.3.1.2',
+		path:  '1.3.6.1.2.1.25.2.3.1.3',
 		total: '1.3.6.1.2.1.25.2.3.1.5',
-		used: '1.3.6.1.2.1.25.2.3.1.6'
+		used:  '1.3.6.1.2.1.25.2.3.1.6'
 	}
 
 	# The fallback warning capacity.
 	WARN_AT = 90
 
+	# Don't alert if a mount is readonly by default.
+	ALERT_READONLY = false
+
+	# Access mode meanings
+	ACCESS_READWRITE = 1
+	ACCESS_READONLY  = 2
 
 	# Configurability API
 	#
@@ -48,6 +55,9 @@ class Arborist::Monitor::SNMP::Disk
 		# What percentage qualifies as a warning
 		setting :warn_at, default: WARN_AT
 
+		# Set down if the mounts are readonly?
+		setting :alert_readonly, default: ALERT_READONLY
+
 		# If non-empty, only these paths are included in checks.
 		#
 		setting :include do |val|
@@ -60,7 +70,7 @@ class Arborist::Monitor::SNMP::Disk
 		# Paths to exclude from checks
 		#
 		setting :exclude,
-			default: [ '^/dev(/.+)?$', '^/net(/.+)?$', '^/proc$', '^/run$', '^/sys/' ] do |val|
+			default: [ '^/dev(/.+)?$', '/dev$', '^/net(/.+)?$', '/proc$', '^/run$', '^/sys/', '/sys$' ] do |val|
 			mounts = Array( val ).map{|m| Regexp.new(m) }
 			Regexp.union( mounts )
 		end
@@ -70,7 +80,9 @@ class Arborist::Monitor::SNMP::Disk
 	### Return the properties used by this monitor.
 	###
 	def self::node_properties
-		return USED_PROPERTIES
+		used_properties = USED_PROPERTIES.dup
+		used_properties << :mounts
+		return used_properties
 	end
 
 
@@ -98,40 +110,54 @@ class Arborist::Monitor::SNMP::Disk
 	### +snmp+ connection.
 	###
 	def gather_disks( host, snmp )
-		mounts  =  self.system =~ /windows\s+/i ? self.windows_disks( snmp ) : self.unix_disks( snmp )
-		config  = self.identifiers[ host ].last || {}
-		warn_at = config[ 'warn_at' ] || self.class.warn_at
+		current_mounts = self.system =~ /windows\s+/i ? self.windows_disks( snmp ) : self.unix_disks( snmp )
+		config         = self.identifiers[ host ].last['config'] || {}
+		warn_at        = config[ 'warn_at' ] || self.class.warn_at
+		alert_readonly = config[ 'alert_readonly' ] || self.class.alert_readonly
+
+		self.log.debug self.identifiers[ host ]
 
 		includes = self.format_mounts( config, 'include' ) || self.class.include
 		excludes = self.format_mounts( config, 'exclude' ) || self.class.exclude
 
-		mounts.reject! do |path, percentage|
+		current_mounts.reject! do |path, data|
+			path = path.to_s
 			excludes.match( path ) || ( includes && ! includes.match( path ) )
 		end
 
 		errors   = []
 		warnings = []
-		mounts.each_pair do |path, percentage|
-
-			warn = begin
-			  if warn_at.is_a?( Hash )
-				  warn_at[ path ] || WARN_AT
-			  else
-				  warn_at
-			  end
+		current_mounts.each_pair do |path, data|
+			warn = if warn_at.is_a?( Hash )
+				warn_at[ path ] || self.class.warn_at
+			else
+				warn_at
 			end
 
-			self.log.debug "%s:%s -> at %d, warn at %d" % [ host, path, percentage, warn ]
+			readonly = alert_readonly.is_a?( Hash ) ? alert_readonly[ path ] : alert_readonly
+
+			self.log.debug "%s:%s -> %p, warn at %d" % [ host, path, data, warn ]
 
-			if percentage >= warn.to_i
-				if percentage >= 100
-					errors << "%s at %d%% capacity" % [ path, percentage ]
+			if data[ :capacity ] >= warn.to_i
+				if data[ :capacity ] >= 100
+					errors << "%s at %d%% capacity" % [ path, data[ :capacity ] ]
 				else
-					warnings << "%s at %d%% capacity" % [ path, percentage ]
+					warnings << "%s at %d%% capacity" % [ path, data[ :capacity ] ]
 				end
 			end
+
+			if readonly && data[ :accessmode ] == ACCESS_READONLY
+				errors << "%s is mounted read-only." % [ path ]
+			end
 		end
 
+		# Remove any past mounts that configuration exclusions should
+		# now omit.
+		mounts = self.identifiers[ host ].last[ 'mounts' ] || {}
+		mounts.keys.each{|k| mounts[k] = nil }
+
+		mounts.merge!( current_mounts )
+
 		self.results[ host ] = { mounts: mounts }
 		self.results[ host ][ :error ]   = errors.join(', ')   unless errors.empty?
 		self.results[ host ][ :warning ] = warnings.join(', ') unless warnings.empty?
@@ -151,18 +177,25 @@ class Arborist::Monitor::SNMP::Disk
 	### Fetch information for Windows systems.
 	###
 	def windows_disks( snmp )
-		raw = snmp.get_bulk([
-			STORAGE_WINDOWS[:path],
-			STORAGE_WINDOWS[:type],
-			STORAGE_WINDOWS[:total],
-			STORAGE_WINDOWS[:used]
-		]).varbinds.map( &:value )
+		paths = snmp.walk( oid: STORAGE_WINDOWS[:path] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		types = snmp.walk( oid: STORAGE_WINDOWS[:type] ).each_with_object( [] ) do |(_, value), acc|
+			acc << WINDOWS_DEVICES.include?( value )
+		end
+		totals = snmp.walk( oid: STORAGE_WINDOWS[:total] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		used = snmp.walk( oid: STORAGE_WINDOWS[:used] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
 
 		disks = {}
-		raw.each_slice( 4 ) do |device|
-			next unless device[1].respond_to?( :oid ) && WINDOWS_DEVICES.include?( device[1].oid )
-			next if device[2].zero?
-			disks[ device[0] ] = (( device[3].to_f / device[2] ) * 100).round( 1 )
+		paths.each_with_index do |path, idx|
+			next if totals[ idx ].zero?
+			next unless types[ idx ]
+			disks[ path ] ||= {}
+			disks[ path ][ :capacity ] = (( used[idx].to_f / totals[idx] ) * 100).round( 1 )
 		end
 
 		return disks
@@ -172,11 +205,20 @@ class Arborist::Monitor::SNMP::Disk
 	### Fetch information for Unix/MacOS systems.
 	###
 	def unix_disks( snmp )
-		raw = snmp.get_bulk([
-			STORAGE_NET_SNMP[:path],
-			STORAGE_NET_SNMP[:percent] ]).varbinds.map( &:value )
+		paths = snmp.walk( oid: STORAGE_NET_SNMP[:path] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		capacities = snmp.walk( oid: STORAGE_NET_SNMP[:percent] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		accessmodes = snmp.walk( oid: STORAGE_NET_SNMP[:access] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
 
-		return Hash[ *raw ]
+		pairs = paths.each_with_object( {} ).with_index do |(p, acc), idx|
+			acc[p] = { capacity: capacities[idx], accessmode: accessmodes[idx] }
+		end
+		return pairs
 	end
 
 end # class Arborist::Monitor::SNMP::Disk

data/lib/arborist/monitor/snmp/memory.rb

@@ -84,7 +84,7 @@ class Arborist::Monitor::SNMP::Memory
 	def gather_memory( host, snmp )
 		info = self.system =~ /windows\s+/i ? self.get_windows( snmp ) : self.get_mem( snmp )
 
-		config           = identifiers[ host ].last || {}
+		config           = self.identifiers[ host ].last['config'] || {}
 		physical_warn_at = config[ 'physical_warn_at' ] || self.class.physical_warn_at
 		swap_warn_at     = config[ 'swap_warn_at' ] || self.class.swap_warn_at
 
@@ -131,7 +131,7 @@ class Arborist::Monitor::SNMP::Memory
 		info  = { memory: {}, swap: {} }
 		mem_idx, swap_idx = nil
 
-		snmp.walk( MEMORY[:windows][:label] ).each_with_index do |(_, val), i|
+		snmp.walk( oid: MEMORY[:windows][:label] ).each_with_index do |(_, val), i|
 			mem_idx  = i + 1 if val =~ /physical memory/i
 			swap_idx = i + 1 if val =~ /virtual memory/i
 		end
@@ -148,8 +148,8 @@ class Arborist::Monitor::SNMP::Memory
 	###
 	def calc_memory( snmp, oids )
 		info = { usage: 0, available: 0 }
-		avail = snmp.get( oids[:avail] ).varbinds.first.value.to_f
-		total = snmp.get( oids[:total] ).varbinds.first.value.to_f
+		avail = snmp.get( oid: oids[:avail] ).to_f
+		total = snmp.get( oid: oids[:total] ).to_f
 		used  = total - avail
 
 		return info if avail.zero?
@@ -166,9 +166,9 @@ class Arborist::Monitor::SNMP::Memory
 		info = { usage: 0, available: 0 }
 		return info unless idx
 
-		units = snmp.get( MEMORY[:windows][:units] + ".#{idx}" ).varbinds.first.value
-		total = snmp.get( MEMORY[:windows][:total] + ".#{idx}" ).varbinds.first.value.to_f * units
-		used  = snmp.get( MEMORY[:windows][:used] + ".#{idx}" ).varbinds.first.value.to_f * units
+		units = snmp.get( oid: MEMORY[:windows][:units] + ".#{idx}" )
+		total = snmp.get( oid: MEMORY[:windows][:total] + ".#{idx}" ).to_f * units
+		used  = snmp.get( oid: MEMORY[:windows][:used] + ".#{idx}" ).to_f * units
 
 		info[ :usage ]     = (( used / total ) * 100 ).round( 2 )
 		info[ :available ] = (( total - used ) / 1024 / 1024 ).round( 2 )

data/lib/arborist/monitor/snmp/process.rb

@@ -71,7 +71,7 @@ class Arborist::Monitor::SNMP::Process
 	#### +snmp+ connection.
 	###
 	def gather_processlist( host, snmp )
-		config = self.identifiers[ host ].last || {}
+		config = self.identifiers[ host ].last['config'] || {}
 		errors = []
 		procs  = self.system =~ /windows\s+/i ? self.get_windows( snmp ) : self.get_procs( snmp )
 
@@ -80,7 +80,7 @@ class Arborist::Monitor::SNMP::Process
 
 		# Check against what is running.
 		#
-		Array( config['processes'] || self.class.check ).each do |process|
+		Array( config['check'] || self.class.check ).each do |process|
 			process_r = Regexp.new( process )
 			found = procs.find{|p| p.match(process_r) }
 			errors << "'%s' is not running" % [ process ] unless found
@@ -95,14 +95,24 @@ class Arborist::Monitor::SNMP::Process
 	###
 	def get_windows( snmp )
 		oids = [ PROCESS[:windows][:path], PROCESS[:windows][:list], PROCESS[:windows][:args] ]
-		return snmp.walk( oids ).each_slice( 3 ). each_with_object( [] ) do |vals, acc|
-			path, process, args = vals[0][1], vals[1][1], vals[2][1]
-			next if path.empty?
 
-			process = "%s%s" % [ path, process ]
-			process << " %s" % [ args ] unless args.empty?
-			acc << process
+		paths = snmp.walk( oid: oids[0] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		procs = snmp.walk( oid: oids[1] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		args = snmp.walk( oid: oids[2] ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
 		end
+
+		return paths.zip( procs, args ).collect do |(path, process, arg)|
+			next unless path && process
+			next if path.empty?
+			path << process unless process.empty?
+			path << " %s" % [ arg.to_s ] if arg && ! arg.empty?
+			path
+		end.compact
 	end
 
 
@@ -110,13 +120,19 @@ class Arborist::Monitor::SNMP::Process
 	###
 	def get_procs( snmp )
 		oids = [ PROCESS[:netsnmp][:list], PROCESS[:netsnmp][:args] ]
-		return snmp.walk( oids ).each_slice( 2 ).each_with_object( [] ) do |vals, acc|
-			process, args = vals[0][1], vals[1][1]
-			next if process.empty?
 
-			process << " %s" % [ args ] unless args.empty?
-			acc << process
+		procs = snmp.walk( oid: oids.first ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
+		end
+		args = snmp.walk( oid: oids.last ).each_with_object( [] ) do |(_, value), acc|
+			acc << value
 		end
+
+		return procs.zip( args ).collect do |(process, arg)|
+			next if process.empty?
+			process << " %s" % [ arg.to_s ] unless arg.empty?
+			process
+		end.compact
 	end
 
 end # class Arborist::Monitor::SNMP::Process

data/lib/arborist/monitor/snmp/ups.rb

@@ -0,0 +1,10 @@
+# -*- ruby -*-
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'arborist/monitor/snmp' unless defined?( Arborist::Monitor::SNMP )
+
+# Namespace for UPS check classes.
+class Arborist::Monitor::SNMP::UPS
+	include Arborist::Monitor::SNMP
+
+end

data/lib/arborist/monitor/snmp/ups/battery.rb

@@ -0,0 +1,136 @@
+# -*- ruby -*-
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'arborist/monitor/snmp/ups' unless defined?( Arborist::Monitor::SNMP::UPS )
+
+# Checks for UPS battery health.
+#
+# Checks the available battery percentage, if the UPS is on battery,
+# and the temperature of the battery.
+#
+class Arborist::Monitor::SNMP::UPS::Battery
+	include Arborist::Monitor::SNMP
+
+	extend Configurability, Loggability
+	log_to :arborist_snmp
+
+	# OIDS for discovering ups status.
+	#
+	OIDS = {
+		battery_status:        '.1.3.6.1.2.1.33.1.2.1.0', # 1 - unk, 2 - normal, 3 - low, 4 - depleted
+		seconds_on_battery:    '.1.3.6.1.2.1.33.1.2.2.0',
+		est_minutes_remaining: '.1.3.6.1.2.1.33.1.2.3.0',
+		est_charge_remaining:  '.1.3.6.1.2.1.33.1.2.4.0', # in percent
+		battery_voltage:       '.1.3.6.1.2.1.33.1.2.5.0', # in 0.1v DC
+		battery_current:       '.1.3.6.1.2.1.33.1.2.6.0', # in 0.1a DC
+		battery_temperature:   '.1.3.6.1.2.1.33.1.2.7.0'  # in Celcius
+	}
+
+	# Human-readable translations for battery status OID.
+	#
+	BATTERY_STATUS = {
+		1 => "Battery status is Unknown.",
+		2 => "Battery is OK.",
+		3 => "Battery is Low.",
+		4 => "Battery is Depleted."
+	}
+
+	# Global defaults for instances of this monitor
+	#
+	configurability( 'arborist.snmp.ups.battery' ) do
+		# What battery percentage qualifies as a warning
+		setting :capacity_warn_at, default: 60
+
+		# What battery temperature qualifies as a warning, in C
+		setting :temperature_warn_at, default: 50
+	end
+
+
+	### Return the properties used by this monitor.
+	###
+	def self::node_properties
+		return USED_PROPERTIES
+	end
+
+
+	### Class #run creates a new instance and immediately runs it.
+	###
+	def self::run( nodes )
+		return new.run( nodes )
+	end
+
+
+	### Perform the monitoring checks.
+	###
+	def run( nodes )
+		super do |host, snmp|
+			self.check_battery( host, snmp )
+		end
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Query SNMP and format information into a hash.
+	###
+	def format_battery( snmp )
+		info = {}
+
+		# basic info that's always available
+		info[ :status ] = snmp.get( oid: OIDS[:battery_status] )
+		info[ :capacity ] = snmp.get( oid: OIDS[:est_charge_remaining] ) rescue nil
+		info[ :temperature ] = snmp.get( oid: OIDS[:battery_temperature] ) rescue nil
+		info[ :minutes_remaining ]  = snmp.get( oid: OIDS[:est_minutes_remaining] ) rescue nil
+
+		# don't report voltage if the UPS doesn't
+		voltage = snmp.get( oid: OIDS[:battery_voltage] ) rescue nil
+		info[ :voltage ] = voltage / 10 if voltage
+
+		# don't report current if the UPS doesn't
+		current = snmp.get( oid: OIDS[:battery_current] ) rescue nil
+		info[ :current ] = current/10 if current
+
+		# see if we are on battery
+		info[ :seconds_on_battery ] = snmp.get( oid: OIDS[:seconds_on_battery] ) rescue 0
+		info[ :in_use ] = ( info[ :seconds_on_battery ] != 0 )
+
+		return { battery: info.compact }
+	end
+
+	### Parse SNMP-provided information and alert based on thresholds.
+	###
+	def check_battery( host, snmp )
+		info = self.format_battery( snmp )
+
+		config    = self.identifiers[ host ].last['config'] || {}
+		cap_warn  = config[ 'capacity_warn_at' ] || self.class.capacity_warn_at
+		temp_warn = config[ 'temperature_warn_at' ] || self.class.temperature_warn_at
+
+		in_use      = info.dig( :battery, :in_use )
+		status      = info.dig( :battery, :status )
+		capacity    = info.dig( :battery, :capacity )
+		temperature = info.dig( :battery, :temperature )
+		warnings	= []
+
+		if in_use
+			mins = info.dig( :battery, :minutes_remaining ) || "(unknown)"
+			warnings << "UPS on battery - %s minute(s) remaning." % [ mins ]
+		end
+
+		warnings << BATTERY_STATUS[ status ] if status != 2
+
+		warnings << "Battery remaining capacity %0.1f%% less than %0.1f percent" %
+			[ capacity, cap_warn ] if capacity && capacity <= cap_warn
+
+		warnings << "Battery temperature %dC greater than %dC" %
+			[ temperature, temp_warn ] if temperature && temperature >= temp_warn
+
+		info[ :warning ] = warnings.join( "\n" ) unless warnings.empty?
+		self.results[ host ] = info
+
+	end
+
+end # class Arborist::Monitor::UPS::Battery
+

data/lib/arborist/snmp.rb

@@ -1,5 +1,6 @@
 # -*- ruby -*-
 #encoding: utf-8
+# vim: set noet nosta sw=4 ts=4 :
 
 require 'loggability'
 require 'arborist'
@@ -14,10 +15,10 @@ module Arborist::SNMP
 
 
 	# Package version
-	VERSION = '0.4.0'
+	VERSION = '0.7.0'
 
 	# Version control revision
-	REVISION = %q$Revision: e0b7c95a154f $
+	REVISION = %q$Revision$
 
 
 	### Return the name of the library with the version, and optionally the build ID if

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arborist-snmp
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Mahlon E. Smith <mahlon@martini.nu>
@@ -11,9 +11,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZtYWhs
+  MIIDMDCCAhigAwIBAgIBAjANBgkqhkiG9w0BAQsFADA+MQ8wDQYDVQQDDAZtYWhs
   b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
-  HhcNMTcxMTIyMjIyMTAyWhcNMTgxMTIyMjIyMTAyWjA+MQ8wDQYDVQQDDAZtYWhs
+  HhcNMjAwNzA5MjIxMzE4WhcNMjEwNzA5MjIxMzE4WjA+MQ8wDQYDVQQDDAZtYWhs
   b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
   ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDpXGN0YbMVpYv4EoiCxpQw
   sxKdyhlkvpvENUkpEhbpnEuMKXgUfRHO4T/vBZf0h8eYgwnrHCRhAeIqesFKfoj9
@@ -21,17 +21,16 @@ cert_chain:
   Fht9ppCuNmxJNd+L3zAX8lD01RUWNRC+8L5QLCjViJtjFDDCFfh9NCirs+XnTCzo
   AJgFbsZIzFJtSiXUtFgscKr4Ik8ruhRbPbYbmx9rf6W74aTMPxggq/d3gj0Eh32y
   WsXsQ5giVnmkbsRkBNu3QyZ8Xr5+7mvy5AWyqXKOrcW7lnYaob6Z9x/MGXGNeD6j
-  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRY8ea6
-  +6kAaW7ukKph2/4MTAD8/TAcBgNVHREEFTATgRFtYWhsb25AbWFydGluaS5udTAc
-  BgNVHRIEFTATgRFtYWhsb25AbWFydGluaS5udTANBgkqhkiG9w0BAQUFAAOCAQEA
-  00FljTeSNaYUqJ59yLRA+i43wVNiO4ETQQu6fYQCPns12Sm90spOJb3SmTDkJ7CY
-  dixOQg5A3Et1LVS+Z/YfH1TAbb50oTWbZbTW2JknHS0hohq3UF1pvbkk1niZ26er
-  skJ352MUfcyaUkQyMmCjL/BpkDutYH5OCGh+FmK8+mH7SoC9Nr48WwH2prVdHs3y
-  OMWFgB33sXdj1XqOd2Rw1WPgAeMeDqWeIrRMpUhNZOwroaA1MAr60f9NIYxua/vx
-  n0YyneERGuHPSRZFgo72tGOqLpAlWnhPxRNqnayZmsg3hPPI87B6MTUI2UQ7VUdh
-  UrSf3b+cPoC8PNfjp8zsdw==
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRY8ea6
+  +6kAaW7ukKph2/4MTAD8/TANBgkqhkiG9w0BAQsFAAOCAQEAryZehbiEumHsUsce
+  FoBVuDoVdlJf8ae11G8IPXnEHCT8S5b+MBSYd55V3aGQm4bKoZA3GmmD8Y0a+oxt
+  l2kkTvE0r1bBb/qYQI97AjnqzHByseBRoaHtJ12JtrDEdi8y4jd5AJt4aW+G/roD
+  I2/ymUodKw9Cteom0RdJNzBUJ+Bq+qFOy7mVKNIfhXRRFYEy11y1712FsJXqUEku
+  qr3lnAEvEy9hQila4NoJT2+aQEKsjVON9D3a727naKDFUcKDg6P4KqS+yOKgR+QH
+  D8llK3JPaqKXuJkbd8jKchDk0Q+fA8Klan5SSnm7pMD51QM1mPsVPm5bEw5ib0bn
+  oR3hTQ==
   -----END CERTIFICATE-----
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arborist
@@ -48,19 +47,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: net-snmp2
+  name: netsnmp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: xorcist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.1'
 description: "\tThis library adds common SNMP resource support to Arborist monitors.\n"
 email: mahlon@martini.nu
 executables: []
@@ -72,6 +85,8 @@ files:
 - lib/arborist/monitor/snmp/disk.rb
 - lib/arborist/monitor/snmp/memory.rb
 - lib/arborist/monitor/snmp/process.rb
+- lib/arborist/monitor/snmp/ups.rb
+- lib/arborist/monitor/snmp/ups/battery.rb
 - lib/arborist/snmp.rb
 homepage: http://bitbucket.org/mahlon/Arborist-SNMP
 licenses:
@@ -92,8 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SNMP support for Arborist monitors

metadata.gz.sig

@@ -0,0 +1 @@
+����ARl΂t�@�����"-Z��E6M�n�0�D�;�
{�6��M�_O���