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.
Raw data
{
"_id": null,
"home_page": "https://github.com/guardian/alerta",
"name": "alerta-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "alert monitoring system wsgi application api",
"author": "Nick Satterly",
"author_email": "nfsatterly@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c1/24/d5101cb16d822312f404176b196af0117ef441d001147a106c424a8eccf7/alerta_server-9.0.4.tar.gz",
"platform": null,
"description": "Alerta Release 9.1\n==================\n\n[](https://github.com/alerta/alerta/actions)\n[](https://slack.alerta.dev)\n[](https://coveralls.io/github/alerta/alerta?branch=master)\n[](https://hub.docker.com/r/alerta/alerta-web)\n\nThe Alerta monitoring tool was developed with the following aims in mind:\n\n* distributed and de-coupled so that it is **SCALABLE**\n* minimal **CONFIGURATION** that easily accepts alerts from any source\n* quick at-a-glance **VISUALISATION** with drill-down to detail\n\n\n\n----\n\nRequirements\n------------\n\nRelease 9 only supports Python 3.9 or higher.\n\nThe only mandatory dependency is MongoDB or PostgreSQL. Everything else is optional.\n\n- Postgres version 13 or better\n- MongoDB version 6.0 or better\n\nInstallation\n------------\n\nTo install MongoDB on Debian/Ubuntu run:\n\n $ sudo apt-get install -y mongodb-org\n $ mongod\n\nTo install MongoDB on CentOS/RHEL run:\n\n $ sudo yum install -y mongodb\n $ mongod\n\nTo install the Alerta server and client run:\n\n $ pip install alerta-server alerta\n $ alertad run\n\nTo install the web console run:\n\n $ wget https://github.com/alerta/alerta-webui/releases/latest/download/alerta-webui.tar.gz\n $ tar zxvf alerta-webui.tar.gz\n $ cd dist\n $ python3 -m http.server 8000\n\n >> browse to http://localhost:8000\n\n### Docker\nAlerta and MongoDB can also run using Docker containers, see [alerta/docker-alerta](https://github.com/alerta/docker-alerta).\n\nConfiguration\n-------------\n\nTo configure the ``alertad`` server override the default settings in ``/etc/alertad.conf``\nor using ``ALERTA_SVR_CONF_FILE`` environment variable::\n\n $ ALERTA_SVR_CONF_FILE=~/.alertad.conf\n $ echo \"DEBUG=True\" > $ALERTA_SVR_CONF_FILE\n\nDocumentation\n-------------\n\nMore information on configuration and other aspects of alerta can be found\nat <http://docs.alerta.io>\n\nDevelopment\n-----------\n\nTo run in development mode, listening on port 5000:\n\n $ export FLASK_APP=alerta FLASK_DEBUG=1\n $ pip install -e .\n $ flask run\n\nTo run in development mode, listening on port 8080, using Postgres and\nreporting errors to [Sentry](https://sentry.io):\n\n $ export FLASK_APP=alerta FLASK_DEBUG=1\n $ export DATABASE_URL=postgres://localhost:5432/alerta5\n $ export SENTRY_DSN=https://8b56098250544fb78b9578d8af2a7e13:fa9d628da9c4459c922293db72a3203f@sentry.io/153768\n $ pip install -e .[postgres]\n $ flask run --debugger --port 8080 --with-threads --reload\n\nTroubleshooting\n---------------\n\nEnable debug log output by setting `DEBUG=True` in the API server\nconfiguration:\n\n```\nDEBUG=True\n\nLOG_HANDLERS = ['console','file']\nLOG_FORMAT = 'verbose'\nLOG_FILE = '$HOME/alertad.log'\n```\n\nIt can also be helpful to check the web browser developer console for\nJavaScript logging, network problems and API error responses.\n\nTests\n-----\n\nTo run the *all* the tests there must be a local Postgres\nand MongoDB database running. Then run:\n\n $ TOXENV=ALL make test\n\nTo just run the Postgres or MongoDB tests run:\n\n $ TOXENV=postgres make test\n $ TOXENV=mongodb make test\n\nTo run a single test run something like:\n\n $ TOXENV=\"mongodb -- tests/test_search.py::QueryParserTestCase::test_boolean_operators\" make test\n $ TOXENV=\"postgres -- tests/test_queryparser.py::PostgresQueryTestCase::test_boolean_operators\" make test\n\nCloud Deployment\n----------------\n\nAlerta can be deployed to the cloud easily using Heroku <https://github.com/alerta/heroku-api-alerta>,\nAWS EC2 <https://github.com/alerta/alerta-cloudformation>, or Google Cloud Platform\n<https://github.com/alerta/gcloud-api-alerta>\n\nLicense\n-------\n\n Alerta monitoring system and console\n Copyright 2012-2023 Nick Satterly\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Alerta server WSGI application",
"version": "9.0.4",
"project_urls": {
"Homepage": "https://github.com/guardian/alerta"
},
"split_keywords": [
"alert",
"monitoring",
"system",
"wsgi",
"application",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1279cd1c2a339ce974437060340e86e4c763054b5600bc32bc7931df019269e2",
"md5": "07c52cba8fb224c6997fae6f10f77017",
"sha256": "fdad31eb7afea4d29eb5c29c850b94216ef83abc302999d035dc245e8faa3321"
},
"downloads": -1,
"filename": "alerta_server-9.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "07c52cba8fb224c6997fae6f10f77017",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 165235,
"upload_time": "2024-09-04T18:22:53",
"upload_time_iso_8601": "2024-09-04T18:22:53.513069Z",
"url": "https://files.pythonhosted.org/packages/12/79/cd1c2a339ce974437060340e86e4c763054b5600bc32bc7931df019269e2/alerta_server-9.0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c124d5101cb16d822312f404176b196af0117ef441d001147a106c424a8eccf7",
"md5": "bc2694976a789e475ff1ed8b4ebd8931",
"sha256": "014ade0ab06cfa35e02d033b2c8676f33024873bf260f9397e7fc2f6ff9d8260"
},
"downloads": -1,
"filename": "alerta_server-9.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bc2694976a789e475ff1ed8b4ebd8931",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 205888,
"upload_time": "2024-09-04T18:22:55",
"upload_time_iso_8601": "2024-09-04T18:22:55.773750Z",
"url": "https://files.pythonhosted.org/packages/c1/24/d5101cb16d822312f404176b196af0117ef441d001147a106c424a8eccf7/alerta_server-9.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 18:22:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "guardian",
"github_project": "alerta",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "alerta-server"
}
JSON
