ElastAlert 2 - Project Guidelines ➔ READ BEFORE POSTING!

[jertel]

This project is a fork of the Yelp ElastAlert project. The Yelp ElastAlert project has not been keeping up with important PRs. As a result the project was forked.

Use this Discussion forum to seek help or advice from the ElastAlert community. If you're experiencing trouble, and have thoroughly read the documentation at https://elastalert2.readthedocs.io as well as reviewed the example rules, then post a new discussion topic rather than commenting on an old topic. Do not create GitHub issues when requesting help! Commenting on old discussions will be ignored. Include enough information for another person to be able to help you. Ex: ElastAlert2 version, Elasticsearch version, all relevant log output, configuration snippets, environment (Docker, Helm, or Direct usage), etc. Make sure all code blocks, log snippets, and configuration or rule samples are surrounded in triple back ticks. It should look like the below shaded area in the preview pane of your post:

some: value
something: else

Please do not ask for help with running Docker, Helm, Elasticsearch, Logstash, Filebeat, or other projects, as there is already documentation and support forums for those projects.

If you suspect a bug in the project, we ask that you provide a reproducible test case via the provided Docker image, as it's difficult and time-consuming to distinguish bugs from user environmental issues. If you are attempting to install ElastAlert 2 on an existing environment, or attempting to build your own custom Docker image, you are welcome to ask others for assistance. If there is no response to your discussion topic, it could mean that the project maintainers do not have additional time to devote to that form of assistance.

If you're interested in submitting a PR, please see the contribution guidelines.

PLEASE NOTE - This fork is a best effort project by other ElastAlert users. There can be no expectation of support. Be respectful and appreciative of any response and assistance that might be provided by your fellow community users.

Finally, when someone provides a response to your support request, you should at a minimum acknowledge their effort to assist you. This goes for most open source projects: contributors are typically unpaid volunteers, spending their own time and resources to try and support you. Ignoring their efforts strips away their energy and motivation, which can cause projects to collapse and become abandoned. Supporters are happy to help, but only as long as their efforts appear to be useful to the community. A simple thumbs up emoji, or a quick "thank you" goes a long way!