mrtazz/AlertDesigner

# AlertDesigner

[![Build Status](https://travis-ci.org/mrtazz/AlertDesigner.svg?branch=master)](https://travis-ci.org/mrtazz/AlertDesigner)
[![Coverage Status](https://coveralls.io/repos/mrtazz/AlertDesigner/badge.svg?branch=master&service=github)](https://coveralls.io/github/mrtazz/AlertDesigner?branch=master)
[![Code Climate](https://codeclimate.com/github/mrtazz/AlertDesigner/badges/gpa.svg)](https://codeclimate.com/github/mrtazz/AlertDesigner)
[![gem version](https://img.shields.io/gem/v/alertdesigner.svg)](https://rubygems.org/gems/alertdesigner)
[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

## Overview
AlertDesigner is a Ruby DSL to create Nagios checks. It attempts to take some
of the repetitive work of creating Nagios alerts away. It's supposed to
complement your existing setup and not necessarily replace it.

This project is no longer actively maintained as I'm not using Nagios anymore. If you have a use case for
it and are interested in maintaining, let me know [on Twitter](https://twitter.com/mrtazz).

## Example

```ruby
AlertDesigner.define do

  # let's use the Nagios formatter
  formatter NagiosFormatter do
    check_template "generic-service"
  end

  {
    "check_nrpe"       => "$USER1$/check_nrpe2 -H $HOSTADDRESS$ -c $ARG1$ -t 30",
    "check_local_disk" => "$USER1$/check_disk -w $ARG1$ -c $ARG2$ -p $ARG3$",
  }.each do |name, check_cmd|

    command name do
      command check_cmd
    end
  end

  # a simple disk space check
  check "/ Partition Disk Space" do
    hostgroups ["freebsd-base"]
    command  "check_nrpe!check_root"
  end

  # define some base checks with repeating properties
  {
    "vulnerable packages"      => "check_nrpe!check_portaudit",
    "FreeBSD security updates" => "check_nrpe!check_freebsd_update",
    "FreeBSD kernel version"   => "check_nrpe!check_freebsd_kernel",
    "zpool status"             => "check_nrpe!check_zpool"
  }.each do |description, check_cmd|

    check description do
      hostgroups ["freebsd-base"]
      command check_cmd
    end

  end

  # set contact groups for specific clusters
  check "Apache Running" do
    hostgroups ["WebServers" => "web-team", "ApiServers" => "api-team"]
    command  "check_nrpe!check_httpd"
  end

end

puts AlertDesigner.format
```

## Installation
Install from rubygems:

```bash
gem install alertdesigner
```

Or in your Gemfile:

```ruby
gem 'alertdesigner'
```

## FAQ
### Couldn't most of this be done with a clever config hierarchy?
Probably.


## Inspiration
- [Gmail Britta](https://github.com/antifuchs/gmail-britta)
- [Chef](https://www.chef.io/)