You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Nick Satterly c9d9b6b43f
Switch try.alerta.io to basic auth
6 days ago
.github Standardize workflow triggers 6 days ago
alerta Enable google auth for demo site 7 days ago
contrib Update contrib apache config 3 years ago
docs Add state transition diagram to docs 3 years ago
examples Support custom backends defined as entry point (#1826) 2 weeks ago
tests feat: Add support for AuthProxy auth (#1657) 1 week ago
.dockerignore build(docker): fix test docker builds (#1473) 2 years ago
.env try6 1 year ago
.flake8 Fix flake W504 issues and ignore flake W503 (#1061) 4 years ago
.flaskenv fix: Replace FLASK_ENV with FLASK_DEBUG (#1824) 3 weeks ago
.gitignore Allow custom resource IDs on all resources 3 years ago
.isort.cfg Bump support versions for Python and MongoDB (#1717) 9 months ago
.pre-commit-config.yaml precommit hook flake8 has moved to github 4 weeks ago
CHANGELOG.md Release 9.0.0 1 week ago
CONTRIBUTING.md Fix linting errors (#1618) 1 year ago
Dockerfile tests(perf): fix broken performance tests 4 weeks ago
LICENSE First commit for Release 5.x 6 years ago
MANIFEST.in Restore old wsgi file as symlink to new (#1216) 3 years ago
Makefile Minor changes to align with other repos 1 week ago
NOTICE Update README for Release 7 4 years ago
README.md fix: Replace FLASK_ENV with FLASK_DEBUG (#1824) 3 weeks ago
VERSION Release 9.0.0 1 week ago
docker-compose.ci.yml Add integration test for SAML2 auth provider 2 years ago
docker-compose.yml try6 1 year ago
fly.toml Switch try.alerta.io to basic auth 6 days ago
mypy.ini mypy should ignore missing imports by default (#1113) 3 years ago
pref-db-rawdata-history perf(db): Do not query for rawData or history if not required 2 years ago
pylintrc Merge pull request #1206 from frasy/master 2 years ago
requirements-ci.txt build(deps): bump lxml from 4.9.1 to 4.9.2 (#1817) 1 week ago
requirements-dev.txt Minor changes to align with other repos 1 week ago
requirements.txt build(deps): bump pytz from 2022.2.1 to 2022.7.1 (#1815) 3 weeks ago
setup.cfg fix: change housekeeping delete threshold to seconds (#1508) 2 years ago
setup.py Bump info and deps for Release 9 4 weeks ago
tox.ini Bump support versions for Python and MongoDB (#1717) 9 months ago
wsgi.py Do not init http handler for CLI commands (#1212) 3 years ago

README.md

Alerta Release 9.0

Actions Status Slack chat Coverage Status Docker Pulls

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

webui


Requirements

Release 9 only supports Python 3.8 or higher.

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

  • Postgres version 11 or better
  • MongoDB version 4.4 or better

Installation

To install MongoDB on Debian/Ubuntu run:

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

To install MongoDB on CentOS/RHEL run:

$ sudo yum install -y mongodb
$ mongod

To install the Alerta server and client run:

$ pip install alerta-server alerta
$ alertad run

To install the web console run:

$ wget https://github.com/alerta/alerta-webui/releases/latest/download/alerta-webui.tar.gz
$ tar zxvf alerta-webui.tar.gz
$ cd dist
$ python3 -m http.server 8000

>> browse to http://localhost:8000

Docker

Alerta and MongoDB can also run using Docker containers, see alerta/docker-alerta.

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 FLASK_DEBUG=1
$ pip install -e .
$ flask run

To run in development mode, listening on port 8080, using Postgres and reporting errors to Sentry:

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

Troubleshooting

Enable debug log output by setting DEBUG=True in the API server configuration:

DEBUG=True

LOG_HANDLERS = ['console','file']
LOG_FORMAT = 'verbose'
LOG_FILE = '$HOME/alertad.log'

It can also be helpful to check the web browser developer console for JavaScript logging, network problems and API error responses.

Tests

To run the all the tests there must be a local Postgres and MongoDB database running. Then run:

$ TOXENV=ALL make test

To just run the Postgres or MongoDB tests run:

$ TOXENV=postgres make test
$ TOXENV=mongodb make test

To run a single test run something like:

$ TOXENV="mongodb -- tests/test_search.py::QueryParserTestCase::test_boolean_operators" make test
$ TOXENV="postgres -- tests/test_queryparser.py::PostgresQueryTestCase::test_boolean_operators" make test

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-2023 Nick Satterly

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.