Skip to main content

Alerta server WSGI application

Project description

[![Build Status](https://travis-ci.org/guardian/alerta.png)](https://travis-ci.org/guardian/alerta) [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)

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

![console](/docs/images/alert-list-rel32.png?raw=true)

Related projects can be found on the Alerta Org Repo at <https://github.com/alerta/>.


Requirements

The only mandatory dependency is MongoDB or PostgreSQL. Everything else is optional.

  • MongoDB version 3.x

  • Postgres version 9.5 or better

Installation

To install MongoDB on Debian/Ubuntu run:

$ sudo apt-get install -y mongodb-org
$ mongod

To install the Alerta server and client run:

$ pip install alerta-server alerta
$ alertad run

To install the web console run:

$ wget -O alerta-web.tgz https://github.com/alerta/angular-alerta-webui/tarball/master
$ tar zxvf alerta-web.tgz
$ cd alerta-angular-alerta-webui-*/app
$ python -m SimpleHTTPServer 8000

>> browse to http://localhost:8000

Configuration

To configure the alertad server override the default settings in /etc/alertad.conf or using ALERTA_SVR_CONF_FILE environment variable:

$ ALERTA_SVR_CONF_FILE=~/.alertad.conf
$ echo "DEBUG=True" > $ALERTA_SVR_CONF_FILE

Documentation

More information on configuration and other aspects of alerta can be found at <http://docs.alerta.io>

Development

To run in development mode, listening on port 5000:

$ export FLASK_APP=alerta
$ pip install -e .
$ flask run

To run in development mode, listening on port 8080, using Postgres and reporting errors to [Sentry](https://sentry.io):

$ export FLASK_APP=alerta
$ export DATABASE_URL=postgres://localhost:5432/alerta5
$ export SENTRY_DSN=https://8b56098250544fb78b9578d8af2a7e13:fa9d628da9c4459c922293db72a3203f@sentry.io/153768
$ pip install -e .
$ flask run --debugger --port 8080 --with-threads --reload

Tests

To run the tests use:

$ ALERTA_SVR_CONF_FILE= nosetests

Cloud Deployment

Alerta can be deployed to the cloud easily using Heroku <https://github.com/alerta/heroku-api-alerta>, AWS EC2 <https://github.com/alerta/alerta-cloudformation>, or Google Cloud Platform <https://github.com/alerta/gcloud-api-alerta>

License

Alerta monitoring system and console Copyright 2012-2017 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.

Project details


Release history Release notifications | RSS feed

This version

5.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alerta-server-5.0.0.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

alerta_server-5.0.0-py2.py3-none-any.whl (90.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file alerta-server-5.0.0.tar.gz.

File metadata

File hashes

Hashes for alerta-server-5.0.0.tar.gz
Algorithm Hash digest
SHA256 e9c31fb657dbe4f59cdce5e517b438e7b03820577c3ecb6329365ed6b288db0e
MD5 702f9337facb84c6298bf289ca31f295
BLAKE2b-256 33a89b2c4d84f62f283adaa687b1f43445690d69cecf7548e9154aa83b21a704

See more details on using hashes here.

Provenance

File details

Details for the file alerta_server-5.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for alerta_server-5.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7a0b31b987b625740d0a8ed62db0459d70949fc6580c5e8e6d8128cffc5e84a2
MD5 fbcf7f3084e20f10d8eb20bd18201d0a
BLAKE2b-256 407a84ca6c728f95440d62a1e4b13495870dc9e1d051217587c23dd9c161ead3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page