cloudstack-nagios 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudstack-nagios (0.1.3)
+    cloudstack-nagios (0.2.0)
       erubis (~> 2.7.0)
       highline (~> 1.6.20)
       sshkit (~> 1.1.0)

data/README.md

@@ -3,6 +3,13 @@
 Cloudstack Nagios helps you monitoring your Cloudstack environment with Nagios.
 Cloudstack Nagios uses the Cloudsdtack API to collect information about system vm's and cloudstack ressources.
 
+## Prerequisites
+
+  * Cloudstack Root Admin keys must be used.
+  * In order to connect to system vms the private ssh key found on the Cloudstack management server under /var/lib/cloud/management/.ssh/id_rsa must be used.
+  * The system vms must be reachable over SSH (default port 3922) from the nagios server executing the checks.
+    * check with 'ssh -i /var/lib/cloud/management/.ssh/id_rsa -p 3922 <router_mgmt_ip>'
+
 ## Installation
 
 Install the cloudstack-cli gem:
@@ -32,18 +39,45 @@ Example content of the configuration file:
 
 ## Usage
 
+### Basics
+
 See the help screen:
 
     $ cs-nagios
 
-Generate nagios host and services configuration for virtual routers:
+### Generate Nagios configuration files
+
+Generate nagios host configuration for virtual routers:
+
+    $ cs-nagios nagios_config host
+
+Generate nagios host configuration for virtual routers:
+
+    $ cs-nagios nagios_config service
 
-    $ cs-nagios config
+Note that you can also use your own ERB templates using the '--template' option to generate the nagios confifuration files.
+
+### Check system vms over ssh
+
+The following checks are available:
+  
+   * memory - measure memory usage in percents
+   * cpu - measure cpu usage in percent
+   * network - measure network usage
+   * rootfs_rw - check if the root file system is writeable
+
+### Enabling snmpd checks
+
+If you want to check your system vms with standard snmp checks instead of checking over SSH, there are commands to configure snmpd on the machines and open the firewall.
+
+   * snmpd_config enable - goes to all the routers and configure snmpd
+   * snmpd_config check - test if port TCP 161 is reachable on routers
+
+Note: If you want to use snmp checks, you have to adapt the nagios configuration files accordingly.
 
 ## References
 -  [Cloudstack API documentation](http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_Root_Admin.html)
 
-
 ## Contributing
 
 1. Fork it

data/lib/cloudstack-nagios/base.rb

@@ -65,10 +65,10 @@ module CloudstackNagios
         objects.select {|r| r[tag_name].downcase == tag.downcase}
       end
 
-      def sshoptions
+      def sshoptions(ssh_key)
        {
          timeout: 5,
-         keys: %w(/var/lib/cloud/management/.ssh/id_rsa),
+         keys: [ssh_key],
          auth_methods: %w(publickey)
        }
       end

data/lib/cloudstack-nagios/cli.rb

@@ -85,7 +85,7 @@ module CloudstackNagios
       require command
     end
 
-    desc ":nagios_config SUBCOMMAND ...ARGS", "Nagios configuration commands"
+    desc "nagios_config SUBCOMMAND ...ARGS", "Nagios configuration commands"
     subcommand :nagios_config, NagiosConfig
 
     desc "snmpd_config SUBCOMMAND ...ARGS", "snmpd configuration commands"

data/lib/cloudstack-nagios/commands/check.rb

@@ -4,7 +4,7 @@ class Check < CloudstackNagios::Base
 
   RETURN_CODES = {0 => 'ok', 1 => 'warning', 2 => 'critical'}
 
-  desc "check memory HOST", "check memory on host"
+  desc "memory HOST", "check memory on host"
   option :host,
       desc: 'hostname or ipaddress',
       required: true,
@@ -19,10 +19,18 @@ class Check < CloudstackNagios::Base
       type: :numeric,
       default: 95,
       aliases: '-c'
+  option :ssh_key,
+      desc: 'ssh private key to use',
+      default: '/var/lib/cloud/management/.ssh/id_rsa'
+  option :port,
+      desc: 'ssh port to use',
+      type: :numeric,
+      default: 3922,
+      aliases: '-p'
   def memory
     host = SSHKit::Host.new("root@#{options[:host]}")
-    host.ssh_options = sshoptions
-    host.port = 3922
+    host.ssh_options = sshoptions(options[:ssh_key])
+    host.port = options[:port]
     free_output = ""
     on host do |h|
       free_output = capture(:free)
@@ -36,7 +44,7 @@ class Check < CloudstackNagios::Base
     exit data[0]
   end
 
-  desc "check cpu", "check memory on host"
+  desc "cpu", "check memory on host"
   option :host,
      desc: 'hostname or ipaddress',
      required: true,
@@ -49,10 +57,18 @@ class Check < CloudstackNagios::Base
       desc: 'critical level',
       type: :numeric,
       default: 95
+  option :ssh_key,
+      desc: 'ssh private key to use',
+      default: '/var/lib/cloud/management/.ssh/id_rsa'
+  option :port,
+      desc: 'ssh port to use',
+      type: :numeric,
+      default: 3922,
+      aliases: '-p'
   def cpu(host)
     host = SSHKit::Host.new("root@#{options[:host]}")
-    host.ssh_options = sshoptions
-    host.port = 3922
+    host.ssh_options = sshoptions(options[:ssh_key])
+    host.port = options[:port]
     mpstat_output = ""
     on host do |h|
       mpstat_output = capture(:mpstat)
@@ -64,7 +80,7 @@ class Check < CloudstackNagios::Base
     exit data[0]
   end
 
-  desc "check rootfs_rw", "check if the rootfs is read/writeable on host"
+  desc "rootfs_rw", "check if the rootfs is read/writeable on host"
   option :host,
       desc: 'hostname or ipaddress',
       required: true,
@@ -79,21 +95,29 @@ class Check < CloudstackNagios::Base
       type: :numeric,
       default: 95,
       aliases: '-c'
+  option :ssh_key,
+      desc: 'ssh private key to use',
+      default: '/var/lib/cloud/management/.ssh/id_rsa'
+  option :port,
+      desc: 'ssh port to use',
+      type: :numeric,
+      default: 3922,
+      aliases: '-p'
   def rootfs_rw
     host = SSHKit::Host.new("root@#{options[:host]}")
-    host.ssh_options = sshoptions
-    host.port = 3922
-    mpstat_output = ""
+    host.ssh_options = sshoptions(options[:ssh_key])
+    host.port = options[:port]
+    proc_out = ""
     on host do |h|
       proc_out = capture(:cat, '/proc/mounts')
     end
     rootfs_rw = proc_out.match(/rootfs\srw\s/)
-    data = check_data(100, usage, options[:warning], options[:critical])
-    puts "ROOTFS_RW #{rootfs_rw ? 'OK - root fs writeable' : 'CRITICAL - rootfs not writeable'}"
-    exit data[0]
+    status = rootfs_rw ? 0 : 2
+    puts "ROOTFS_RW #{rootfs_rw ? 'OK - rootfs writeable' : 'CRITICAL - rootfs NOT writeable'}"
+    exit status
   end
 
-  desc "check network", "check network usage on host"
+  desc "network", "check network usage on host"
   option :host,
       desc: 'hostname or ipaddress',
       required: true,
@@ -108,10 +132,18 @@ class Check < CloudstackNagios::Base
       type: :numeric,
       default: 95,
       aliases: '-c'
+  option :ssh_key,
+      desc: 'ssh private key to use',
+      default: '/var/lib/cloud/management/.ssh/id_rsa'
+  option :port,
+      desc: 'ssh port to use',
+      type: :numeric,
+      default: 3922,
+      aliases: '-p'
   def network
     host = SSHKit::Host.new("root@#{options[:host]}")
-    host.ssh_options = sshoptions
-    host.port = 3922
+    host.ssh_options = sshoptions(options[:ssh_key])
+    host.port = options[:port]
     r1, t1, r2, t2 = ""
     on host do |h|
       r1 = capture(:cat, '/sys/class/net/eth0/statistics/rx_bytes').to_f

data/lib/cloudstack-nagios/commands/nagios_config.rb

@@ -1,13 +1,23 @@
 class NagiosConfig < CloudstackNagios::Base
 
-  desc "nagios_config hosts", "generate nagios hosts configuration for virtual routers"
+  desc "hosts", "generate nagios hosts configuration for virtual routers"
+  option :template,
+    desc: "path of ERB template to use",
+    default: File.join(File.dirname(__FILE__), '..', 'templates', 'cloudstack_routers_hosts.cfg.erb'),
+    aliases: '-t'
   def hosts
-    puts load_template("cloudstack_routers_hosts.cfg.erb").result(routers: routers)
+  	host_template = load_template(options[:template])
+    puts host_template.result(routers: cs_routers)
   end
 
-  desc "nagios_config services", "generate nagios services configuration for virtual routers"
+  desc "services", "generate nagios services configuration for virtual routers"
+  option :template,
+    desc: "path of ERB template to use",
+    default: File.join(File.dirname(__FILE__), '..', 'templates', 'cloudstack_routers_services.cfg.erb'),
+    aliases: '-t'
   def services
-    puts load_template("cloudstack_routers_services.cfg.erb").result(routers: routers)
+  	service_template = load_template(options[:template])
+    puts service_template.result(routers: cs_routers)
   end
 
  end

data/lib/cloudstack-nagios/commands/snmpd_config.rb

@@ -4,11 +4,11 @@ require 'timeout'
 
 class SnmpdConfig < CloudstackNagios::Base
 
-  desc "snmpd_config check [vms]", "check if snmpd is configured on virtual routers"
+  desc "check [vms]", "check if snmpd is configured on virtual routers"
   def check(*vms)
     if vms.size == 0
       say 'Get a list of all routers from cloudstack..', :yellow
-      vms = router_ips(routers)
+      vms = router_ips
     end
     vms.each do |host|
       begin
@@ -23,20 +23,28 @@ class SnmpdConfig < CloudstackNagios::Base
     end
   end
 
-  desc "snmpd_config enable [vms]", "enable snmpd configuration on virtual routers"
+  desc "enable [vms]", "enable snmpd configuration on virtual routers"
   option :apt,
       desc: 'use apt-get to install snmpd packages',
       type: :boolean
+  option :ssh_key,
+      desc: 'ssh private key to use',
+      default: '/var/lib/cloud/management/.ssh/id_rsa'
+  option :port,
+      desc: 'ssh port to use',
+      type: :numeric,
+      default: 3922,
+      aliases: '-p'
   def enable(*vms)
     apt = options[:apt]
     if vms.size == 0
-      say 'Get a list of all routers from cloudstack..', :yellow
+      say 'Get a list of all routers from Cloudstack..', :yellow
       vms = router_ips
     end
     hosts = vms.map do |router|
       host = SSHKit::Host.new("root@#{router}")
-      host.ssh_options = sshoptions
-      host.port = 3922
+      host.ssh_options = sshoptions(options[:ssh_key])
+      host.port = options[:port]
       host
     end
     say 'Connect to router and enable snmpd...', :yellow
@@ -57,7 +65,7 @@ class SnmpdConfig < CloudstackNagios::Base
 
   no_commands do
 
-    def router_ips(vrs = routers)
+    def router_ips(vrs = cs_routers)
       ips = []
       vrs.each do |router|
         ips << router['linklocalip'] unless router['linklocalip'] == nil

data/lib/cloudstack-nagios/helper.rb

@@ -1,13 +1,18 @@
 module CloudstackNagios
   module Helper
-    def load_template(name)
-      templ = File.read(File.join(File.dirname(__FILE__), "templates", name))
-      Erubis::Eruby.new(templ)
+    def load_template(template_path)
+      if File.file?(template_path)
+        templ = File.read(template_path)
+        return Erubis::Eruby.new(templ)
+      else
+        say "Error: template not found #{template_path}"
+        exit 1
+      end
     end
 
-    def routers
-      routers = client.list_routers
-      routers += client.list_routers(projectid: -1)
+    def cs_routers
+      routers = client.list_routers(status: 'Running')
+      routers += client.list_routers(projectid: -1, status: 'Running')
     end
   end
 end

data/lib/cloudstack-nagios/version.rb

@@ -1,3 +1,3 @@
 module CloudstackNagios
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack-nagios
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors: