arborist-snmp 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a1e7f51762b179cee87fda4bc23a7f8e5875cf5
-  data.tar.gz: e4455394ab0a4e0f5affa2aba4053ec915585dad
+SHA256:
+  metadata.gz: 968e138781d430383f877e95e7eff1450f79cd76f5bb0aa1caa529759c9c8cd8
+  data.tar.gz: 9fd01fba144b94cf1439ed7b93df52762f7467ad29666ee05ce009880e74a7bc
 SHA512:
-  metadata.gz: 61225e9bd9a10ae9ede1072b30dda70fb93910b2f1210e67d60c368ace730aaebe1ae0ee8b3fadf9ce5e1d85ec33b5970be12d6f0c262def2dc18ef4cf7b2d64
-  data.tar.gz: a725b24835f6d7a9eabd04c7ea36a4fe8ecbdbaab2a3863021aa28d125e1969009b1e8f8d569e42b89586bdbb4137010dbad9d8012b3b98e26c97c64922f0a4e
+  metadata.gz: f7f16b4bacaf7c8763164d854b470af466e4e7e49a75ac4358967c0bf9bbdaac3382eaced06463dc973821d657773f9e54595ffdedf6cd0e8a1b0c400d6a70be
+  data.tar.gz: 8706512e163d1d06808b80db3ca8a2a1d4a3694e16155f2bfff83e34cae34d26ff365b8f667ac060366fb111b40f4632ea37ab973ba867d9e3b4f3038c4c3168

data/lib/arborist/monitor/snmp.rb

@@ -135,4 +135,6 @@ 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
@@ -96,8 +92,8 @@ class Arborist::Monitor::SNMP::CPU
 		#
 		else
 			snmp.walk( oid: OIDS[:load] ).each_with_index do |(_, value), idx|
-				next unless LOADKEYS[ idx + 1 ]
-				info[ :load ][ LOADKEYS[idx + 1] ] = value.to_f
+				next unless LOADKEYS[ idx ]
+				info[ :load ][ LOADKEYS[idx] ] = value.to_f
 			end
 
 			percentage = (( ( info[:load][ :load5 ] / cpus.size) - 1 ) * 100 ).round( 1 )

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 )
+
+#
+class Arborist::Monitor::SNMP::UPS
+	include Arborist::Monitor::SNMP
+
+end

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

@@ -0,0 +1,132 @@
+# -*- ruby -*-
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'arborist/monitor/snmp/ups' unless defined?( Arborist::Monitor::SNMP::UPS )
+
+#
+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] )
+		info[ :temperature ] = snmp.get( oid: OIDS[:battery_temperature] )
+		info[ :minutes_remaining ]  = snmp.get( oid: OIDS[:est_minutes_remaining] )
+
+		# don't report voltage if the UPS doesn't
+		voltage = snmp.get( oid: OIDS[:battery_voltage] ) rescue nil
+		info[ :voltage ] = voltage / 10 unless voltage.nil?
+
+		# don't report current if the UPS doesn't
+		current = snmp.get( oid: OIDS[:battery_current] ) rescue nil
+		info[ :current ] = current/10 unless current.nil?
+
+		# 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 }
+	end
+
+	### Parse SNMP-provided information and alert based on thresholds.
+	###
+	def check_battery( host, snmp )
+		info = self.format_battery( snmp )
+
+		config  = identifiers[ host ].last || {}
+		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 )
+			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 <= cap_warn
+
+		warnings << "Battery temperature %dC greater than %dC" %
+			[ temperature, temp_warn ] if 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

@@ -14,10 +14,10 @@ module Arborist::SNMP
 
 
 	# Package version
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 
 	# Version control revision
-	REVISION = %q$Revision: e4f0fd44734d $
+	REVISION = %q$Revision$
 
 
 	### Return the name of the library with the version, and optionally the build ID if

metadata

@@ -1,37 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: arborist-snmp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mahlon E. Smith <mahlon@martini.nu>
 - Michael Granger <ged@faeriemud.org>
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZtYWhs
-  b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
-  HhcNMTcxMTIyMjIyMTAyWhcNMTgxMTIyMjIyMTAyWjA+MQ8wDQYDVQQDDAZtYWhs
-  b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
-  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDpXGN0YbMVpYv4EoiCxpQw
-  sxKdyhlkvpvENUkpEhbpnEuMKXgUfRHO4T/vBZf0h8eYgwnrHCRhAeIqesFKfoj9
-  mpEJk5JUuADOAz18aT+v24UqAtJdiwBJLuqhslSNB6CFXZv3OOMny9bjoJegz0hI
-  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==
-  -----END CERTIFICATE-----
-date: 2018-06-13 00:00:00.000000000 Z
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arborist
@@ -86,6 +64,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:
@@ -107,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SNMP support for Arborist monitors