Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add limit_execution #107

Merged
merged 3 commits into from
May 4, 2021
Merged

docs: add limit_execution #107

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97cd7fd
docs: add limit_execution
May 3, 2021
ceb4af3
docs: add limit_execution
May 3, 2021
6069df0
Merge branch 'feature/update-documentation' of github.com:fberrez/ela…
May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/source/ruletypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ Rule Configuration Cheat Sheet
+--------------------------------------------------------------+ |
| ``es_send_get_body_as`` (string, default "GET") | |
+--------------------------------------------------------------+ |
| ``aggregation`` (time, no default) | |
| ``aggregation`` (time, no default) | |
+--------------------------------------------------------------+ |
| ``limit_execution`` (string, no default) | |
+--------------------------------------------------------------+ |
| ``description`` (string, default empty string) | |
+--------------------------------------------------------------+ |
Expand Down Expand Up @@ -400,6 +402,15 @@ Then, for the same sample data shown above listing alice and bob's events, Elast
past events will result in different alerts than if elastalert had been running while those events occured. This behavior can be changed
by setting ``aggregate_by_match_time``.

limit_execution
^^^^^^^^^^^^^^^

``limit_execution``: This option allows you to activate the rule during a limited period of time. This uses the cron format.

For example, if you wish to activate the rule from monday to friday, between 10am to 6pm::

limit_execution: "* 10-18 * * 1-5"

aggregate_by_match_time
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down