Skip to content

Commit

Permalink
Add timestamp_field to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ApolloLV authored Sep 27, 2024
1 parent c885e9f commit c4cba0c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ Rule Configuration Cheat Sheet
+--------------------------------------------------------------+ +
| ``buffer_time`` (time, default from config.yaml) | |
+--------------------------------------------------------------+ |
| ``timestamp_field`` (string, default "@timestamp") | |
+--------------------------------------------------------------+ |
| ``timestamp_type`` (string, default iso) | |
+--------------------------------------------------------------+ |
| ``timestamp_format`` (string, default "%Y-%m-%dT%H:%M:%SZ") | |
Expand Down Expand Up @@ -971,6 +973,14 @@ summary_suffix

``summary_suffix``: Specify a suffix string, which will be added after the aggregation summary table. This string is currently not subject to any formatting.

timestamp_field
^^^^^^^^^^^^^^

``timestamp_field``: Specify the name of the document field containing the timestamp.
By default, the field ``@timestamp`` is used to query Elasticsearch.
If ``timestamp_field`` is set, this date field will be considered whenever querying, filtering and aggregating based on timestamps.
(Optional, string, default @timestamp).

timestamp_type
^^^^^^^^^^^^^^

Expand Down

0 comments on commit c4cba0c

Please sign in to comment.