Skip to content

Commit c0d51ab

Browse files
committed
docs
1 parent 3866d97 commit c0d51ab

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/resources/kibana_alerting_rule.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,30 @@ Required:
8686

8787
Optional:
8888

89+
- `alerts_filter` (Block List, Max: 1) Conditions that affect whether the action runs. If you specify multiple conditions, all conditions must be met for the action to run. For example, if an alert occurs within the specified time frame and matches the query, the action runs. (see [below for nested schema](#nestedblock--actions--alerts_filter))
8990
- `frequency` (Block List, Max: 1) The properties that affect how often actions are generated. If the rule type supports setting summary to true, the action can be a summary of alerts at the specified notification interval. Otherwise, an action runs for each alert at the specified notification interval. NOTE: You cannot specify these parameters when `notify_when` or `throttle` are defined at the rule level. (see [below for nested schema](#nestedblock--actions--frequency))
9091
- `group` (String) The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names.
9192

93+
<a id="nestedblock--actions--alerts_filter"></a>
94+
### Nested Schema for `actions.alerts_filter`
95+
96+
Optional:
97+
98+
- `kql` (String) Defines a query filter that determines whether the action runs. Written in Kibana Query Language (KQL).
99+
- `timeframe` (Block List, Max: 1) Defines a period that limits whether the action runs. (see [below for nested schema](#nestedblock--actions--alerts_filter--timeframe))
100+
101+
<a id="nestedblock--actions--alerts_filter--timeframe"></a>
102+
### Nested Schema for `actions.alerts_filter.timeframe`
103+
104+
Required:
105+
106+
- `days` (List of Number) Defines the days of the week that the action can run, represented as an array of numbers. For example, 1 represents Monday. An empty array is equivalent to specifying all the days of the week.
107+
- `hours_end` (String) Defines the range of time in a day that the action can run. The end of the time frame in 24-hour notation (hh:mm).
108+
- `hours_start` (String) Defines the range of time in a day that the action can run. The start of the time frame in 24-hour notation (hh:mm).
109+
- `timezone` (String) The ISO time zone for the hours values. Values such as UTC and UTC+1 also work but lack built-in daylight savings time support and are not recommended.
110+
111+
112+
92113
<a id="nestedblock--actions--frequency"></a>
93114
### Nested Schema for `actions.frequency`
94115

0 commit comments

Comments
 (0)