mirror of
https://github.com/alerta/alerta.git
synced 2025-01-24 01:10:24 +00:00
150 lines
4.5 KiB
Markdown
150 lines
4.5 KiB
Markdown
Alerta Release 9.1
|
|
==================
|
|
|
|
[](https://github.com/alerta/alerta/actions)
|
|
[](https://slack.alerta.dev)
|
|
[](https://coveralls.io/github/alerta/alerta?branch=master)
|
|
[](https://hub.docker.com/r/alerta/alerta-web)
|
|
|
|
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
|
|
|
|
|
|
|
|
----
|
|
|
|
Requirements
|
|
------------
|
|
|
|
Release 9 only supports Python 3.9 or higher.
|
|
|
|
The only mandatory dependency is MongoDB or PostgreSQL. Everything else is optional.
|
|
|
|
- Postgres version 13 or better
|
|
- MongoDB version 6.0 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](https://github.com/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](https://sentry.io):
|
|
|
|
$ 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.
|