Nagios checks for Cloudstack
Ruby HTML Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
.gitignore
.ruby-version
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
cloudstack-nagios.gemspec

README.md

Cloudstack Nagios

Gem Version

CloudStack Nagios helps you monitoring your Cloudstack environment with Nagios/Icinga. CloudStack Nagios uses the CloudStack API to collect information about system vm's and resources.

The following checks are supported:

  • system and network checks for virtual routers
  • storage pool capacity checks
  • global zone capacities

Prerequisites

  • CloudStack Root Admin keys have to be used.
  • In order to connect to system vm's the private ssh key found on the CloudStack management server under /var/lib/cloud/management/.ssh/id_rsa are required.
  • The system vm's must be reachable on the Cloudstack Management Network 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:

$ gem install cloudstack-nagios

Setup

Create the initial configuration:

$ cs-nagios setup

cloudstack-nagios expects to find a configuration file with the API URL and your CloudStack credentials in your home directory named .cloudstack-cli.yml. If the file is located elsewhere you can specify the location using the --config option.

cloudstack-nagios supports multiple environments using the --environment option.

Example content of the configuration file:

:url:         "https://my-cloudstack-server/client/api/"
:api_key:     "cloudstack-api-key"
:secret_key:  "cloudstack-api-secret"

test:
  :url:         "http://my-cloudstack-testserver/client/api/"
  :api_key:     "cloudstack-api-key"
  :secret_key:  "cloudstack-api-secret"

Usage

Basics

See the help screen:

$ cs-nagios

Generate all Nagios configuration files at once

Generate all configuration files:

$ cs-nagios nagios_config generate all

You can also generate each config file individually. The following types are available:

$ cs-nagios nagios_config list
all
hostgroups
zone_hosts
router_hosts
router_services
system_vm_hosts
system_vm_services
capacities
async_jobs
storage_pools

System VM checks

For all vm checks access to the CloudStack management network is required in order to run the checks via SSH or SNMP.

Types

cloudstack-nagios differentiates between 2 different types of system vm's:

  • routers: cs-nagios check router
  • secondary storage vm's and console proxies: cs-nagios check system_vm

Checks

The following checks are available:

General Checks

  • memory - measure memory usage in percents
  • cpu - measure cpu usage in percent
  • network - measure network usage
  • fs_rw - check if the root file system is writeable
  • rootfs_rw - check if the root file system is writeable (wrapper for fs_rw with mount point /)
  • disk_usage - check the disks space usage of the root volume

Checks for routers

  • conntrack_connections, check the number of conntrack connections and set proper limits if needed
  • active_ftp - make sure conntrack_ftp and nf_nat_ftp modules are loaded and enable it if needed

Examples:

$ cs-nagios check system_vm network --host 10.100.9.161
$ cs-nagios check router active_ftp --host 10.100.9.177

Enabling snmpd checks for system vms

If you want to check your system vm's with standard Nagios 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.

Capacity checks

Checks various global capacity values.

Example:

$ cs-nagios check capacity memory --zone ZUERICH_IX

Storage pool checks

Checks the available disk space on CloudStack storage pools.

Example:

$ cs-nagios check storage_pool --pool_name fs_cs_zone01_pod01

Async jobs checks

Checks the number of pending async jobs.

Example:

$ cs-nagios check async_jobs

Snapshot checks

Checks for snapshots which are not in state 'BakedUp' for a certain amount of time.

Example:

$ cs-nagios check snapshots

References

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. See the LICENSE file for further details.