Please note that Flapjack's master branch currently represents the
v2.0.0-alpha.1 pre-release of this gem. You may be looking for the documentation for the release branch. Many things have changed for Flapjack v2, and the documentation needs to be fixed before the actual release.
Flapjack is a flexible monitoring notification routing system that handles:
- Alert routing (determining who should receive alerts based on interest, time of day, scheduled maintenance, etc)
- Alert summarisation (with per-user, per media summary thresholds)
- Your standard operational tasks (setting scheduled maintenance, acknowledgements, etc)
Flapjack will be immediately useful to you if:
- You want to identify failures faster by rolling up your alerts across multiple monitoring systems.
- You monitor infrastructures that have multiple teams responsible for keeping them up.
- Your monitoring infrastructure is multitenant, and each customer has a bespoke alerting strategy.
- You want to dip your toe in the water and try alternative check execution engines like Sensu, Icinga, or cron in parallel to Nagios.
Try it out with the Quickstart Guide
The Quickstart guide will help you get Flapjack up and running in a VM locally using Vagrant and VirtualBox.
The technical low-down
Flapjack provides a scalable method for dealing with events representing changes in system state (OK -> WARNING -> CRITICAL transitions) and alerting appropriate people as necessary.
At its core, Flapjack processes events received from external check execution engines, such as Nagios. Nagios provides a 'perfdata' event output channel, which writes to a named pipe.
flapjack-nagios-receiver then reads from this named pipe, converts each line to JSON and adds them to the events queue.
Flapjack sits downstream of check execution engines (like Nagios, Sensu, Icinga, or cron), processing events to determine:
- if a problem has been detected
- who should know about the problem
- how they should be told
Additional check engines can be supported by adding additional receiver processes similar to the nagios receiver.
Ubuntu Precise 64 (12.04):
Tell apt to trust the Flapjack package signing key:
gpg --keyserver keys.gnupg.net --recv-keys 803709B6 gpg -a --export 803709B6 | sudo apt-key add -
Add the Flapjack Debian repository to your Apt sources:
echo "deb http://packages.flapjack.io/deb/v1 precise main" | sudo tee /etc/apt/sources.list.d/flapjack.list
Install the latest Flapjack package:
sudo apt-get update sudo apt-get install flapjack
Alternatively, download the deb and install using
sudo dpkg -i <filename>
The Flapjack package is an Omnibus package and as such contains most dependencies under
/opt/flapjack, including Redis.
Installing the package will start Redis (non standard port) and Flapjack. You should now be able to access the Flapjack Web UI at:
And consume the REST API at:
N.B. The Redis installed by Flapjack runs on a non-standard port (6380), so it doesn't conflict with other Redis instances you may already have installed.
Currently we only make a package for Ubuntu Precise (amd64). If you feel comfortable getting a ruby environment going on your preferred OS, then you can also just install Flapjack from rubygems.org:
gem install flapjack
Alternatively, you can add support for your OS of choice to omnibus-flapjack and build a native package. Pull requests welcome, and we'll help you make this happen!
You'll also need Redis >= 2.6.12.
Have a look at the default config file and modify things as required. The package installer copies this to
/etc/flapjack/flapjack_config.toml if it doesn't already exist.
# edit the config sudo vi /etc/flapjack/flapjack_config.toml # reload the config sudo /etc/init.d/flapjack reload
Ubuntu Precise 64:
After installing the Flapjack package, Redis and Flapjack should be automatically started.
First up, start Redis if it's not already started:
# status: sudo /etc/init.d/redis-flapjack status # start: sudo /etc/init.d/redis-flapjack start
# status: sudo /etc/init.d/flapjack status # reload: sudo /etc/init.d/flapjack reload # restart: sudo /etc/init.d/flapjack restart # stop: sudo /etc/init.d/flapjack stop # start: sudo /etc/init.d/flapjack start
Using - Details
We are updating this section of the docs.
Note that the master branch is still undergoing breaking changes and is for Flapjack 2. Building packages from the master branch is unlikely to work. Current stable builds are built from the maint/1.x branch.
We have the documentation for this project on a github wiki and also referenced as a submodule at /doc in this project. Run the following commands to populate the local doc/ directory:
git submodule init git submodule update
If you make changes to the documentation locally, here's how to publish them:
- Checkout master within the doc subdir, otherwise you'll be commiting to no branch, a.k.a. no man's land.
- git add, commit and push from inside the doc subdir
- Add, commit and push the doc dir from the root (this updates the pointer in the main git repo to the correct ref in the doc repo, we think...)
All of the documentation.