mirror of https://github.com/status-im/cabot.git
117 lines
5.7 KiB
Markdown
117 lines
5.7 KiB
Markdown
Cabot
|
|
=====
|
|
[](https://travis-ci.org/arachnys/cabot) [](http://cabotapp.com/qs/quickstart.html)
|
|
|
|
Cabot is a free, open-source, self-hosted infrastructure monitoring platform that provides some of the best features of [PagerDuty](http://www.pagerduty.com), [Server Density](http://www.serverdensity.com), [Pingdom](http://www.pingdom.com) and [Nagios](http://www.nagios.org) 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](https://github.com/graphite-project/graphite-web)
|
|
* Status code and response content of web endpoints
|
|
* [Jenkins](http://jenkins-ci.org) build statuses
|
|
|
|
We built Cabot as a Christmas project at [Arachnys](https://www.arachnys.com) 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](https://www.djangoproject.com/), [Bootstrap](http://getbootstrap.com/), [Font Awesome](http://fontawesome.io) and a whole host of other goodies under the hood.
|
|
|
|
## Screenshots
|
|
|
|
### Services dashboard
|
|
|
|
|
|
|
|
### Single service overview
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
Using Fabric/Vagrant: Deploy in 5 minutes or less using [official quickstart guide at cabotapp.com](http://cabotapp.com/qs/quickstart.html).
|
|
|
|
Using Docker: Deploy in 10 minutes using shoonoise's Docker/Maestro
|
|
setup with instructions:
|
|
[shoonoise/cabot-docker](https://github.com/shoonoise/cabot-docker)
|
|
|
|
## How it works
|
|
|
|
Docs have moved to [cabotapp.com](http://cabotapp.com)
|
|
|
|
Sections:
|
|
|
|
* [Configuration](http://cabotapp.com/use/configuration.html)
|
|
* [Deployment](http://cabotapp.com/use/deployment.html)
|
|
* [Services](http://cabotapp.com/use/services.html)
|
|
* [Graphite checks](http://cabotapp.com/use/graphite-checks.html)
|
|
* [Jenkins checks](http://cabotapp.com/use/jenkins-checks.html)
|
|
* [HTTP checks](http://cabotapp.com/use/http-checks.html)
|
|
* [Alerting](http://cabotapp.com/use/alerting.html)
|
|
* [Users](http://cabotapp.com/use/users.html)
|
|
* [Rota](http://cabotapp.com/use/rota.html)
|
|
|
|
For those who want to contribute:
|
|
|
|
* [Help develop](http://cabotapp.com/dev/get-started.html)
|
|
* [Contribute code](http://cabotapp.com/dev/contribute-code.html)
|
|
|
|
## 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).
|
|
|
|
|
|
|
|
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](http://www.django-rest-framework.org/api-guide/filtering#djangofilterbackend) documentation.
|
|
|
|
## License
|
|
|
|
See `LICENSE` file in this repo.
|