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.
 
 
 
 
Nick Satterly 3511ec0231
deps: update to Flask 2.0.1 (#1535)
4 months ago
.github build: ldap port number has changed (#1439) 9 months ago
alerta deps: update to Flask 2.0.1 (#1535) 4 months ago
contrib Update contrib apache config 1 year ago
docs Add state transition diagram to docs 1 year ago
examples Add forwarder plugin for federated Alerta (#1161) 1 year ago
tests deps: update to Flask 2.0.1 (#1535) 4 months ago
.dockerignore build(docker): fix test docker builds (#1473) 7 months ago
.env Set alert id to last receive id when forwarding 10 months ago
.flake8 Fix flake W504 issues and ignore flake W503 (#1061) 2 years ago
.flaskenv Use Flask dotenv file to set default env and port (#812) 3 years ago
.gitignore Allow custom resource IDs on all resources 1 year ago
.isort.cfg Add integration test for SAML2 auth provider 11 months ago
.pre-commit-config.yaml fix: change housekeeping delete threshold to seconds (#1508) 5 months ago
CHANGELOG.md Bump version 8.5.0 -> 8.6.0 4 months ago
Dockerfile build(docker): fix test docker builds (#1473) 7 months ago
LICENSE First commit for Release 5.x 4 years ago
MANIFEST.in Restore old wsgi file as symlink to new (#1216) 1 year ago
Makefile build(github): use pull_request_target event 10 months ago
NOTICE Update README for Release 7 2 years ago
README.md Update slack badge link 10 months ago
VERSION Bump version 8.5.0 -> 8.6.0 4 months ago
docker-compose.ci.yml Add integration test for SAML2 auth provider 11 months ago
docker-entrypoint.sh Debug docker entrypoint script (#1203) 1 year ago
mypy.ini mypy should ignore missing imports by default (#1113) 2 years ago
pref-db-rawdata-history perf(db): Do not query for rawData or history if not required 10 months ago
pylintrc Merge pull request #1206 from frasy/master 11 months ago
requirements-ci.txt build(deps): bump lxml from 4.6.2 to 4.6.3 (#1486) 5 months ago
requirements-dev.txt deps: update to Flask 2.0.1 (#1535) 4 months ago
requirements.txt deps: update to Flask 2.0.1 (#1535) 4 months ago
setup.cfg fix: change housekeeping delete threshold to seconds (#1508) 5 months ago
setup.py deps: update to Flask 2.0.1 (#1535) 4 months ago
tox.ini Set alert tags from alert actions 10 months ago
wsgi.py Do not init http handler for CLI commands (#1212) 1 year ago

README.md

Alerta Release 8.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 8 only supports Python 3.6 or higher.

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

  • Postgres version 9.5 or better
  • MongoDB version 3.6 or better (4.0.7 required for full query syntax support)

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_ENV=development
$ 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_ENV=development
$ 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-2020 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.