Skip to content

Commit

Permalink
Merge pull request #1200 from pboushy/patch-1
Browse files Browse the repository at this point in the history
Correct --days description, add --start and --end
  • Loading branch information
jertel authored Jun 9, 2023
2 parents 5acbb9d + 6883a62 commit 5ef314b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -987,9 +987,17 @@ and missing or misconfigured fields.

``--count-only``: Only find the number of matching documents and list available fields. ElastAlert 2 will not be run and documents will not be downloaded.

``--days N``: Instead of the default 1 day, query N days. For selecting more specific time ranges, you must run ElastAlert 2 itself and use ``--start``
``--days N``: Instead of the default 1 day, query N days. For selecting more specific time ranges, use ``--start``
and ``--end``.

``--start <timestamp>`` The starting date/time of the search filter's time range. The timestamp is formatted as
``YYYY-MM-DDTHH:MM:SS`` (UTC) or with timezone ``YYYY-MM-DDTHH:MM:SS-XX:00``
(UTC-XX). If ``timeframe`` is specified, defaults to the ending time - timeframe. Otherwise defaults to ending time - 1 day.

``--end <timestamp>`` The ending date/time of the search filter's time range. The timestamp is formatted as
``YYYY-MM-DDTHH:MM:SS`` (UTC) or with timezone ``YYYY-MM-DDTHH:MM:SS-XX:00``
(UTC-XX). Defaults to the current time.

``--save-json FILE``: Save all documents downloaded to a file as JSON. This is useful if you wish to modify data while testing or do offline
testing in conjunction with ``--data FILE``. A maximum of 10,000 documents will be downloaded.

Expand Down

0 comments on commit 5ef314b

Please sign in to comment.