No Description

Frank Hamand 39bb12b9c1 0.10.8 8 months ago
bin e24f0cf026 Make bin/test_with_coverage executable 9 months ago
cabot d0eefc60e7 Make alert test correctly show "ALERT_TEST" as the failing check 8 months ago
conf 9afcd119ee Add slack settings to production env example 8 months ago
upstart fbaa120653 Add better string escaping to upstart template just in case somebody has an exclamation point in a Django key or something. 2 years ago
.coveragerc a68c2f6b5d Add test coverage support 1 year ago
.foreman 06fe6c884a Clean repo 4 years ago
.gitignore 0329cdf08e Ignore Pipfile.lock for now 10 months ago
.travis.yml fe8d30354e Fix travis test command 9 months ago
CHANGES 39bb12b9c1 0.10.8 8 months ago
Dockerfile 2f79bc5a23 Switch to using alpine linux for docker container 11 months ago
LICENSE 06fe6c884a Clean repo 4 years ago
MANIFEST.in df3e799cbc Add static files and templates to MANIFEST.in 11 months ago
Pipfile f92060d842 Update to django 1.11 8 months ago
Procfile 8dd27fb82c Fix all workers running beats 11 months ago
Procfile.dev 8dd27fb82c Fix all workers running beats 11 months ago
README.md 187eb93393 Merge pull request #472 from arachnys/gitter-badge 9 months ago
Vagrantfile d41d748bd8 Require YAML in Vagrantfile (#344) 1 year ago
docker-compose-base.yml ec5f6825e2 Add default.env and test.env and multiple docker-compose files to override settings 11 months ago
docker-compose-test.yml 0597d4db34 Change test compose command with entrypoint 9 months ago
docker-compose.yml 0d3b09c058 Persist postgres data between runs using docker-compose 8 months ago
docker-entrypoint.sh ed32dea05f Update to celery 4 10 months ago
example_local_config.yml 569c71d0b1 Make Cabot work on 14.04 as well as 12.04 3 years ago
fabfile.py bce10a7b57 Merge pull request #476 from doboy/include-git 9 months ago
gunicorn.conf 4227d7865f Don't use gevent anymore 3 years ago
makemigrations 43ae71a986 Added support for alert plugins 2 years ago
manage.py 6fdb2f05f9 More tweaks for Python packaging 3 years ago
requirements-dev.txt 75ce4b6133 Update dev requirements 10 months ago
requirements-plugins.txt 557a5c9c87 Update slack plugin to 0.8.1 8 months ago
requirements.txt f92060d842 Update to django 1.11 8 months ago
setup.py d77087efad Handle running setup.py from non .git source 9 months ago
setup_dev.sh 06fe6c884a Clean repo 4 years ago
tox.ini f337b79643 Add Flake8 linting using tox 1 year ago

README.md

Cabot

Build Status PyPI version Coverage Status Requirements Status Gitter

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 Docker: Deploy in 5 minutes or less using official quickstart guide at cabotapp.com. (See also https://hub.docker.com/r/cabotapp/cabot/)

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.