opennebula_nagios_probe 1.0.0

data/lib/probe/opennebula_oned_probe.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+###########################################################################
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+###########################################################################
+
+require 'opennebula_probe'
+require 'opennebula'
+
+include OpenNebula
+
+# OpenNebulaOnedProbe - XML-RPC ONED client query service implementation.
+
+class OpenNebulaOnedProbe < OpennebulaProbe
+  FAILED_CONNECTIVITY = 'Failed to check connectivity: '
+  FAILED_RESOURCE = 'Failed to check resource availability: '
+
+  def initialize(opts)
+    super(opts)
+
+    # OpenNebula credentials
+    @credentials = "#{@opts.username}:#{@opts.password}"
+    @client = Client.new(@credentials, @endpoint)
+  end
+
+  def check_pool(pool, msg)
+    rc = pool.info
+    fail "#{msg} #{rc.message}" if OpenNebula.is_error?(rc)
+  end
+
+  def check_crit
+    @logger.info "Checking for basic connectivity at #{@endpoint}"
+
+    pool_class_array = [VirtualNetworkPool, ImagePool, VirtualMachinePool]
+    pool_class_array.each do |pool_class|
+      pool = pool_class.new(@client, -1)
+      check_pool(pool, FAILED_CONNECTIVITY)
+    end
+
+    false
+
+  rescue StandardError => e
+    @logger.error "Failed to check basic connectivity: #{e.message}"
+    @logger.debug "#{e.backtrace.join("\n")}"
+    return true
+  end
+
+  def check_resources(resources)
+    if resources.map { |x| x[:resource] }.reduce(true) { |product, resource| product && resource.nil? }
+      @logger.info 'There are no resources to check, for details on how to specify resources see --help'
+      return false
+    end
+
+    resources.each do |resource_hash|
+      resource = resource_hash[:resource]
+
+      next unless resource
+
+      @logger.info "Looking for #{resource_hash[:resource_string]}s: #{resource.inspect}"
+      pool = resource_hash[:resource_pool].new(@client, -1)
+      check_pool(pool, FAILED_RESOURCE)
+
+      resource.each do |resource_to_look_for|
+        found = false
+
+        pool.each do |res|
+          check_pool(res, FAILED_RESOURCE)
+          found = true if res.id.to_s == resource_to_look_for
+        end
+        fail "#{resource_hash[:resource_string].capitalize} #{resource_to_look_for} not found" unless found
+      end
+    end
+
+    false
+  end
+
+  def check_warn
+    @logger.info "Checking for resource availability at #{@endpoint}"
+
+    resources = []
+    resources << { resource: @opts.storage, resource_string: 'image', resource_pool: ImagePool }
+    resources << { resource: @opts.compute, resource_string: 'compute instance', resource_pool: VirtualMachinePool }
+    resources << { resource: @opts.network, resource_string: 'network', resource_pool: VirtualNetworkPool }
+
+    check_resources(resources)
+
+  rescue StandardError => e
+    @logger.error "Failed to check resource availability: #{e.message}"
+    @logger.debug "#{e.backtrace.join("\n")}"
+    return true
+  end
+end

data/lib/probe/opennebula_probe.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+###########################################################################
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+###########################################################################
+
+###########################################################################
+# Nagios code explanation (source: https://www.nagios-plugins.org/doc/guidelines.html, q. 11-26-2013)
+#
+# OK/UP - The plugin was able to check the service and it appeared to be functioning properly
+# WARNING - The plugin was able to check the service, but it appeared to be above some "warning"
+# threshold or did not appear to be working properly
+# CRITICAL/DOWN - The plugin detected that either the service was not running or it was above
+# some "critical" threshold
+# UNKNOWN - Invalid command line arguments were supplied to the plugin or low-level failures internal to the plugin
+# (such as unable to fork, or open a tcp socket) that prevent it from performing the specified operation.
+# Higher-level errors (such as name resolution errors, socket timeouts, etc) are outside of the control of plugins
+# and should generally NOT be reported as UNKNOWN states.
+###########################################################################
+
+OK       = 0
+WARNING  = 1
+CRITICAL = 2
+UNKNOWN  = 3
+
+# OpennebulaProbe covers generic implementation of subprobes.
+# ==== Attributes
+# * logger - Logger connector.
+# * message - Resulting message.
+# * retval - Probe status constant.
+# * endpoint - Server URI.
+#
+# ==== Options
+# * opts - Hash with parsed command line arguments.
+#
+# ==== Examples
+# Instance is initialized from child class
+
+class OpennebulaProbe
+  OK_MSG    = 'Remote resources successfully queried!'
+  WARN_MSG  = 'Failed to query specified remote resources!'
+  CRIT_MSG  = 'Failed to establish connection with the remote server!'
+  UNKWN_MSG = 'An exception or error occured!'
+
+  attr_reader :retval, :message
+  attr_writer :logger
+
+  def initialize(opts = {})
+    @opts     = opts
+    @retval   = UNKNOWN
+    @logger   = nil
+    @message  = "#{UNKWN_MSG}"
+    @endpoint = "#{@opts.protocol.to_s}://#{@opts.hostname}:#{@opts.port.to_s}#{@opts.path}"
+  end
+
+  def check_crit
+    # overridden in child class
+    true
+  end
+
+  def check_warn
+    # overridden in child class
+    true
+  end
+
+  def crit?
+    return false unless check_crit
+    @retval  = CRITICAL
+    @message = "CRITICAL: #{CRIT_MSG}"
+    true
+  end
+
+  def warn?
+    return false unless check_warn
+    @retval  = WARNING
+    @message = "WARNING: #{WARN_MSG}"
+    true
+  end
+
+  def run
+    unless crit?
+      unless warn?
+        @retval  = OK
+        @message = "#{OK_MSG}"
+      end
+    end
+  end
+end

data/lib/probe/optparse_nagios_probe.rb

@@ -0,0 +1,174 @@
+# encoding: UTF-8
+###########################################################################
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+###########################################################################
+
+require 'optparse'
+require 'ostruct'
+
+# OptparseNagiosProbe - opennebula-nagios probes ARGV parser class.
+
+class OptparseNagiosProbe
+  VERSION = 0.99
+
+  def self.parse(args)
+    options = OpenStruct.new
+
+    options.debuglevel = 0
+
+    options.hostname = 'localhost'
+    options.port     = 2633
+    options.path     = '/'
+    options.protocol = :http
+    options.username = 'oneadmin'
+    options.password = 'onepass'
+
+    options.service = :oned
+    options.occi    = :occi
+
+    options.timeout = 60
+
+    options.user_cred = nil
+    options.voms = false
+
+    opts_ = OptionParser.new do |opts|
+      opts.banner = 'Usage: check_opennebula.rb [options]'
+
+      opts.separator ''
+      opts.separator 'Connection options:'
+
+      opts.on('--protocol [http|https]', [:http, :https], "Protocol to use, defaults to 'http'") do |protocol|
+        options.protocol = protocol
+      end
+
+      opts.on('--hostname [HOSTNAME]', String, "Host to be queried, defaults to 'localhost'") do |hostname|
+        options.hostname = hostname
+      end
+
+      opts.on('--port [PORT_NUMBER]', Integer, "Port to be queried, defaults to '2633'") do |port|
+        options.port = port
+      end
+
+      opts.on('--path [PATH]', String, 'Path to the service endpoint'\
+      + "(the last part of the URI, should always start with a slash), defaults to '/'") do |path|
+        options.path = path
+      end
+
+      opts.on('--username [USERNAME]', String, 'Username for authentication purposes, '\
+      + "defaults to 'oneadmin'") do |username|
+        options.username = username
+      end
+
+      opts.on('--password [PASSWORD]', String, 'Password for authentication purposes, '\
+      + "defaults to 'onepass'") do |password|
+        options.password = password
+      end
+
+      opts.separator ''
+      opts.separator 'Session options:'
+
+      opts.on('--timeout [SECONDS]', Integer, "Timeout time in seconds, defaults to '60'") do |timeout|
+        options.timeout = timeout
+      end
+
+      opts.separator ''
+      opts.separator 'Service options:'
+
+      opts.on('--service [SERVICE_NAME]', [:oned, :occi, :econe, :rocci], 'Name of the cloud service'\
+       + " to check [oned, occi, rocci, econe], defaults to 'oned'") do |service|
+        options.service = service
+      end
+
+      opts.on("--check-network [ID'S]", Array, 'Comma separated list of network IDs to check') do |network|
+        options.network = network
+      end
+
+      opts.on("--check-storage [ID'S]", Array, 'Comma separated list of storage IDs to check') do |storage|
+        options.storage = storage
+      end
+
+      opts.on("--check-compute [ID'S]", Array, 'Comma separated list of VM IDs to check') do |compute|
+        options.compute = compute
+      end
+
+      opts.on('--createvm [TEMPLATE_UUID]', String, 'rOCCI template uuid') do |tmpl|
+        options.template_uuid = tmpl
+      end
+
+      opts.on('--name [NAME]', String, 'Name for VM instantiated from template') do |vmname|
+        options.vmname = vmname
+      end
+
+      opts.separator ''
+      opts.separator 'X.509 options:'
+
+      opts.on('--user-cred [PATH]', String, "Path to user's X.509 credentials, defaults to ~/.globus/usercred.pem'")\
+        do |ucred|
+        options.user_cred = ucred
+      end
+
+      opts.on('--ca-file [PATH]', String, 'Path to CA certificates bundle in a file') do |cafile|
+        options.ca_file = cafile
+      end
+
+      opts.on('--ca-path [PATH]', String, 'Path to CA certificates directory, defaults to "/etc/grid-security/certificates"')\
+       do |capath|
+        options.ca_path = capath
+      end
+
+      opts.on('--voms', '--[no-]voms', 'Enable VOMS credentials; modifies behavior of the X.509 authN module')\
+       do |voms|
+        options.voms = voms
+      end
+
+      opts.separator ''
+      opts.separator 'Common options:'
+
+      opts.on('--debuglevel [NUMBER]', Integer, "Run with debugging mode on certain level, defaults to '0'") do |debug|
+        if !debug
+          options.debug_level = 1
+        else
+          options.debug_level = debug
+        end
+
+        # Param. correction - normalize debug level to max 2, minus sign interpreted as switch, no problem there
+        options.debug_level %= 3
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit!
+      end
+
+      opts.on_tail('--version', 'Show version') do
+        puts VERSION
+        exit!
+      end
+
+    end
+
+    opts_.parse!(args)
+
+    # Emphasize required fields
+    mandatory = [:protocol, :hostname, :port, :path, :service, :password]
+    mandatory << :username unless options.user_cred
+
+    options_hash = options.marshal_dump
+
+    # Bug here, i am not sure the mandatory params working
+    missing = mandatory.select { |param| options_hash[param].nil? }
+    fail StandardError, "Missing required arguments #{missing.join(', ')}" unless missing.empty?
+
+    options
+  end
+end

data/opennebula_nagios_probe.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name          = 'opennebula_nagios_probe'
+  gem.version       = '1.0.0'
+  gem.authors       = ['Boris Parak', 'Filip Hubik', 'Michal Kimle' ]
+  gem.email         = ['parak@cesnet.cz', 'hubik@ics.muni.cz', 'kimle.michal@gmail.com']
+  gem.description   = %q{This gem is collection of nagios probes (one, econe, occi, rocci) for OpenNebula cloud platform}
+  gem.summary       = %q{OpenNebula nagios probes}
+  gem.homepage      = 'https://github.com/arax/opennebula-nagios-probes'
+  gem.license       = 'Apache License, Version 2.0'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  gem.require_paths = ['lib']
+  gem.executables   = ['check_opennebula']
+
+  gem.add_dependency 'nagios-probe',	'~> 0.1'
+  gem.add_dependency 'log4r',		'~> 1.1'
+  gem.add_dependency 'amazon-ec2',	'~> 0.9'
+  gem.add_dependency 'occi-cli',	'~> 4.2'
+  gem.add_dependency 'opennebula-oca',  '~> 4.4'
+  gem.add_dependency 'occi-api', 	'~> 4.2'
+
+  gem.add_development_dependency 'rspec',          '~> 2.14'
+  gem.add_development_dependency 'webmock',        '~> 1.9'
+  gem.add_development_dependency 'vcr',            '~> 2.8'
+  gem.add_development_dependency 'rake', 	   '~> 10.1'
+  gem.add_development_dependency 'bundler', 	   '~> 1.3'  
+
+  gem.required_ruby_version     = '>= 1.9.3'
+end

data/spec/probe/fixtures/cassettes/econe/econe_critical_existing_resources.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://localhost:2345/
+    body:
+      encoding: US-ASCII
+      string: AWSAccessKeyId=nagios-probes-test&Action=DescribeImages&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-04-18T11%3A44%3A03Z&Version=2010-08-31&Signature=yUyjdPgO3iXIfZrj%2FtbiO8lM2qrZ2ZOc%2FbjvfzJ5Jxo%3D
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - github-amazon-ec2-ruby-gem
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Apr 2013 11:44:03 GMT
+      Server:
+      - thin 1.3.1 codename Triple Espresso
+      X-Frame-Options:
+      - sameorigin
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Type:
+      - application/xml
+      Content-Length:
+      - '880'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0"?><DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"><requestId>783c292a-71db-4fa9-9028-4576aaf983d5</requestId><imagesSet><item><name>ttylinux
+        - kvm</name><description>ttylinux</description><imageId>ami-00000006</imageId><imageLocation>7ba83cabcea65882790fbe449d25e4ca</imageLocation><imageState>available</imageState><imageOwnerId>nagios-probes-test</imageOwnerId><isPublic>false</isPublic><architecture>i386</architecture><imageType>machine</imageType></item><item><name>ttylinux
+        - kvm2</name><description>ttylinux</description><imageId>ami-00000007</imageId><imageLocation>07193573e51336e1bce9aedc2492bbc6</imageLocation><imageState>available</imageState><imageOwnerId>nagios-probes-test</imageOwnerId><isPublic>false</isPublic><architecture>i386</architecture><imageType>machine</imageType></item></imagesSet></DescribeImagesResponse>
+    http_version:
+  recorded_at: Thu, 18 Apr 2013 11:44:03 GMT
+- request:
+    method: post
+    uri: https://localhost:2345/
+    body:
+      encoding: US-ASCII
+      string: AWSAccessKeyId=nagios-probes-test&Action=DescribeInstances&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-04-18T11%3A44%3A03Z&Version=2010-08-31&Signature=pVdE33jTb1CpxwbzvB1%2F65LUc6eD6WFEfRx%2B0qXLIuw%3D
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - github-amazon-ec2-ruby-gem
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Apr 2013 11:44:03 GMT
+      Server:
+      - thin 1.3.1 codename Triple Espresso
+      X-Frame-Options:
+      - sameorigin
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Type:
+      - application/xml
+      Content-Length:
+      - '1785'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0"?><DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"><requestId>a8784da1-e29c-4220-8602-ced606d12702</requestId><reservationSet><item><reservationId>default</reservationId><ownerId>nagios-probes-test</ownerId><groupSet><item><groupId>default</groupId></item></groupSet><instancesSet><item><instanceId>i-00000009</instanceId><imageId></imageId><instanceState><code>0</code><name>pending</name></instanceState><keyName>none</keyName><productCodes/><instanceType></instanceType><launchTime>2013-04-04T13:29:49+02:00</launchTime><placement><availabilityZone>default</availabilityZone></placement><amiLaunchIndex>9</amiLaunchIndex><kernelId>eki-EA801065</kernelId><ramdiskId>eri-1FEE1144</ramdiskId><monitoring><state>false</state></monitoring></item><item><instanceId>i-00000010</instanceId><imageId></imageId><instanceState><code>0</code><name>pending</name></instanceState><keyName>none</keyName><productCodes/><instanceType></instanceType><launchTime>2013-04-04T13:29:49+02:00</launchTime><placement><availabilityZone>default</availabilityZone></placement><amiLaunchIndex>10</amiLaunchIndex><kernelId>eki-EA801065</kernelId><ramdiskId>eri-1FEE1144</ramdiskId><monitoring><state>false</state></monitoring></item><item><instanceId>i-00000011</instanceId><imageId></imageId><instanceState><code>0</code><name>pending</name></instanceState><keyName>none</keyName><productCodes/><instanceType></instanceType><launchTime>2013-04-04T13:30:33+02:00</launchTime><placement><availabilityZone>default</availabilityZone></placement><amiLaunchIndex>11</amiLaunchIndex><kernelId>eki-EA801065</kernelId><ramdiskId>eri-1FEE1144</ramdiskId><monitoring><state>false</state></monitoring></item></instancesSet></item></reservationSet></DescribeInstancesResponse>
+    http_version:
+  recorded_at: Thu, 18 Apr 2013 11:44:03 GMT
+recorded_with: VCR 2.4.0