mirror of
https://github.com/alerta/alerta.git
synced 2025-02-11 08:18:53 +00:00
139 lines
3.6 KiB
Markdown
139 lines
3.6 KiB
Markdown
Alerta Release 3.2
|
|
==================
|
|
|
|
[](https://travis-ci.org/satterly/alerta)
|
|
|
|
The alerta monitoring tool was developed with the following aims in mind:
|
|
|
|
* distributed and de-coupled so that it is **SCALABLE**
|
|
* minimal **CONFIGURATION** that easily accepts alerts from any source
|
|
* quick at-a-glance **VISUALISATION** with drill-down to detail
|
|
|
|
|
|
|
|
More screenshots are available [here](/docs/images/)
|
|
|
|
Related projects can be found [here][1].
|
|
|
|
Requirements
|
|
------------
|
|
|
|
The only requirement is MongoDB. Everything else is optional.
|
|
|
|
- MongoDB
|
|
|
|
Optional
|
|
--------
|
|
|
|
A messaging transport that supports [AMQP][2] is required for notification to alert subscribers. It is recommended to use RabbitMQ, but Redis and even MongoDB have been tested and shown to work.
|
|
|
|
- RabbitMQ
|
|
- Redis
|
|
- MongoDB
|
|
|
|
Note: The default setting uses MongoDB so that no additional configuration is required.
|
|
|
|
Installation
|
|
------------
|
|
|
|
To install and configure on Debian/Ubuntu:
|
|
|
|
```
|
|
$ sudo apt-get update
|
|
$ sudo apt-get install mongodb-server
|
|
```
|
|
|
|
To use RabbitMQ as the message transport instead of the default MongoDB install the additional packages:
|
|
|
|
```
|
|
$ sudo apt-get install rabbitmq-server
|
|
```
|
|
|
|
To install from git:
|
|
|
|
```
|
|
$ git clone https://github.com/guardian/alerta.git alerta
|
|
$ cd alerta
|
|
$ sudo pip install -r requirements.txt
|
|
$ sudo python setup.py install
|
|
```
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
The configuration file format has changed in Release 3.2 to a python `settings.py` file. To override default settings in this file create `/etc/alertad.conf` or set `ALERTA_SVR_CONF_FILE` environment variable to `~/.alertad.conf` or `~/.config/alertad` or something similar. Make sure to to export the environment variable before running the server, like so:
|
|
|
|
```
|
|
export ALERTA_SVR_CONF_FILE=~/.alertad.conf
|
|
```
|
|
|
|
The default configuration should work. If you are using RabbitMQ change the `AMQP_URL` setting to:
|
|
|
|
```
|
|
AMQP_URL = 'amqp://guest:guest@localhost:5672//'
|
|
```
|
|
|
|
Running
|
|
-------
|
|
|
|
To start the alerta server simply run:
|
|
|
|
```
|
|
$ alertad
|
|
```
|
|
|
|
To send some test alerts run:
|
|
|
|
```
|
|
$ contrib/examples/create-alerts.sh
|
|
```
|
|
|
|
To view alerts in a terminal run:
|
|
|
|
```
|
|
$ alerta query
|
|
```
|
|
|
|
To view alerts in a web console install the [Alerta Web UI][3]
|
|
|
|
Deploy to the Cloud
|
|
-------------------
|
|
|
|
[](https://heroku.com/deploy)
|
|
|
|
More Information
|
|
----------------
|
|
|
|
See the alerta [docs][4]. Documentation is a work in progress. Feedback welcome.
|
|
|
|
Contribute
|
|
----------
|
|
|
|
If you'd like to contribute to Alerta, start by forking this repo on GitHub.
|
|
|
|
http://github.com/guardian/alerta
|
|
|
|
Create a branch for your work and then send us a pull request.
|
|
|
|
License
|
|
-------
|
|
|
|
Alerta monitoring system and console
|
|
Copyright 2012 Guardian News & Media
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
[1]: <https://github.com/alerta/> "Alerta GitHub Repo"
|
|
[2]: <http://kombu.readthedocs.org/en/latest/userguide/connections.html#amqp-transports> "Kombu Transports"
|
|
[3]: <https://github.com/alerta/angular-alerta-webui> "Alerta Web UI"
|
|
[4]: <http://docs.alerta.io/> "Alerta Documentation"
|