ElastAlert 2 is the supported fork of ElastAlert, which had been maintained by the Yelp team but become mostly stale when the Yelp team ceased using ElastAlert.
ElastAlert 2 is backwards compatible with the original ElastAlert rules.
Documentation, including an FAQ, for ElastAlert 2 can be found on readthedocs.com. This is the place to start if you're not familiar with ElastAlert 2 at all.
The full list of platforms that ElastAlert 2 can fire alerts into can be found in the documentation.
Please see our contributing guidelines.
If you're interested in a pre-built Docker image check out the elastalert2 project on Docker Hub.
Be aware that the latest tag of the image represents the latest commit into the master branch. If you prefer to upgrade more slowly you will need utilize a versioned tag, such as 2.1.0 instead, or 2 if you are comfortable with always using the latest released version of ElastAlert 2.
A properly configured config.yaml file must be mounted into the container during startup of the container. Use the example file provided as a template, and once saved locally to a file such as /tmp/elastalert.yaml, run the container as follows:
docker run -d -v /tmp/elastalert.yaml:/opt/elastalert/config.yaml jertel/elastalert2To build the image locally run the following command:
docker build . -t elastalert2See the Helm chart README.md for information on installing this application into an existing Kubernetes cluster.
ElastAlert 2 is licensed under the Apache License, Version 2.0.