Repository files navigation

Cabot is a free, open-source, self-hosted infrastructure monitoring platform that provides some of the best features ofPagerDuty,Server Density,Pingdom andNagios 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 fromGraphite
• Status code and response content of web endpoints
• Jenkins build statuses

We built Cabot as a Christmas project atArachnys 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 usesDjango,Bootstrap,Font Awesome and a whole host of other goodies under the hood.

Using Docker: Deploy in 5 minutes or less usingofficial quickstart guide at cabotapp.com. (See alsohttps://hub.docker.com/r/cabotapp/cabot/)

Docs have moved tocabotapp.com

Sections:

• Configuration
• Deployment
• Services
• Graphite checks
• Jenkins checks
• HTTP checks
• Alerting
• Users
• Rota

For those who want to contribute:

• Help develop
• Contribute code

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).

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

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

To view individual items, append the itemid to the url. For example, to viewgraphite_check 1, browse:

/api/graphite_checks/1/

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 allstatus_check subclasses, add the following permissions:

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

Access the Django admin page athttps://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 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 alljenkins_checks with debounce enabled and CRITICAL importance:

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

Sortgraphite_checks byname field, ascending:

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

Sort byname field, descending:

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

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

SeeLICENSE file in this repo.