Self-hosted, easily-deployable monitoring and alerts service - like a lightweight PagerDuty
JavaScript Python HTML CSS Shell
Latest commit 206abcd Feb 20, 2017 @frankh frankh committed on GitHub Merge pull request #436 from arachnys/fix-bool-settings
Coerce environment vars to Boolean
Permalink
Failed to load latest commit information.
bin Automatically initialise database and assets on docker start Feb 9, 2017
cabot Coerce environment vars to Boolean Feb 20, 2017
conf Drop django-smtp-ssl in favor of Django's native feature Feb 16, 2017
upstart Add better string escaping to upstart template just in case somebody … Apr 3, 2015
.coveragerc Add test coverage support Dec 22, 2016
.foreman Clean repo Jan 5, 2014
.gitignore Add static files and templates to MANIFEST.in Feb 17, 2017
.travis.yml Use travis's default docker-compose version Feb 16, 2017
CHANGES Update CHANGES Feb 20, 2017
Dockerfile Switch to using alpine linux for docker container Feb 13, 2017
LICENSE Clean repo Jan 5, 2014
MANIFEST.in Add static files and templates to MANIFEST.in Feb 17, 2017
Procfile Fix all workers running beats Feb 9, 2017
Procfile.dev Fix all workers running beats Feb 9, 2017
README.md Fix MIT license shield Feb 9, 2017
Vagrantfile Require YAML in Vagrantfile (#344) May 16, 2016
docker-compose-base.yml Add default.env and test.env and multiple docker-compose files to ove… Feb 13, 2017
docker-compose-test.yml Add temporary 'sut' service to docker-compose-test Feb 16, 2017
docker-compose.yml Expose port 5001 for web container Feb 16, 2017
docker-entrypoint.sh Add comment for wait_for_migrations hack Feb 16, 2017
example_local_config.yml Make Cabot work on 14.04 as well as 12.04 Jan 22, 2015
fabfile.py Automatically create UserProfiles Oct 5, 2016
gunicorn.conf Don't use gevent anymore Aug 2, 2014
makemigrations Added support for alert plugins Feb 9, 2015
manage.py Revert "Puts manage.py on $PATH and reads .env by default" Aug 1, 2014
requirements-dev.txt Update django_coverage_plugin Feb 16, 2017
requirements-plugins.txt Update to Django 1.7 Feb 6, 2017
requirements.txt Add whitenoise for serving static files Feb 17, 2017
setup.py Add static files and templates to MANIFEST.in Feb 17, 2017
setup_dev.sh Clean repo Jan 5, 2014
tox.ini Add Flake8 linting using tox Dec 8, 2016

README.md

Cabot

Build Status docs Coverage Status License: MIT

Cabot is a free, open-source, self-hosted infrastructure monitoring platform that provides some of the best features of PagerDuty, Server Density, Pingdom and Nagios without their cost and complexity. (Nagios, I'm mainly looking at you.)

It provides a web interface that allows you to monitor services (e.g. "Stage Redis server", "Production ElasticSearch cluster") and send telephone, sms or hipchat/email alerts to your on-duty team if those services start misbehaving or go down - all without writing a line of code. Best of all, you can use data that you're already pushing to Graphite/statsd to generate alerts, rather than implementing and maintaining a whole new system of data collectors.

You can alert based on:

  • Metrics from Graphite
  • Status code and response content of web endpoints
  • Jenkins build statuses

We built Cabot as a Christmas project at Arachnys because we couldn't wrap our heads around Nagios, and nothing else out there seemed to fit our use case. We're open-sourcing it in the hope that others find it useful.

Cabot is written in Python and uses Django, Bootstrap, Font Awesome and a whole host of other goodies under the hood.

Screenshots

Services dashboard

Services dashboard

Single service overview

Individual service overview

Quickstart

Using Fabric/Vagrant: Deploy in 5 minutes or less using official quickstart guide at cabotapp.com.

Using Docker: Deploy in 10 minutes using shoonoise's Docker/Maestro setup with instructions: shoonoise/cabot-docker

How it works

Docs have moved to cabotapp.com

Sections:

For those who want to contribute:

FAQ

Why "Cabot"?

My dog is called Cabot and he loves monitoring things. Mainly the presence of food in his immediate surroundings, or perhaps the frequency of squirrel visits to our garden. He also barks loudly to alert us on certain events (e.g. the postman coming to the door).

Cabot watching... something

It's just a lucky coincidence that his name sounds like he could be an automation tool.

API

The API has automatically generated documentation available by browsing https://cabot.yourcompany.com/api. The browsable documentation displays example GET requests and lists other allowed HTTP methods.

To view individual items, append the item id to the url. For example, to view graphite_check 1, browse:

/api/graphite_checks/1/

Authentication

The API allows HTTP basic auth using standard Django usernames and passwords as well as session authentication (by submitting the login form on the login page). The API similarly uses standard Django permissions to allow and deny API access.

All resources are GETable by any authenticated user, but individual permissions must be granted for POST, PUT, and other write methods.

As an example, for POST access to all status_check subclasses, add the following permissions:

cabotapp | status check | Can add graphite status check
cabotapp | status check | Can add http status check
cabotapp | status check | Can add icmp status check
cabotapp | status check | Can add jenkins status check

Access the Django admin page at https://cabot.yourcompany.com/admin to add/remove users, change user permissions, add/remove groups for group-based permission control, and change group permissions.

Sorting and Filtering

Sorting and filtering can be used by both REST clients and on the browsable API. All fields visible in the browsable API can be used for filtering and sorting.

Get all jenkins_checks with debounce enabled and CRITICAL importance:

https://cabot.yourcompany.com/api/jenkins_checks/?debounce=1&importance=CRITICAL

Sort graphite_checks by name field, ascending:

https://cabot.yourcompany.com/api/graphite_checks/?ordering=name

Sort by name field, descending:

https://cabot.yourcompany.com/api/graphite_checks/?ordering=-name

Other (non-Cabot specific) examples are available in the Django REST Framework documentation.

License

See LICENSE file in this repo.