Skip to content

Commit

Permalink
Merge pull request #107 from fberrez/feature/update-documentation
Browse files Browse the repository at this point in the history
docs: add limit_execution
  • Loading branch information
jertel authored May 4, 2021
2 parents ef4cbcb + 6069df0 commit 14aab3d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/source/ruletypes.rst
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

0 comments on commit 14aab3d

Please sign in to comment.