You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/r/monitor.html.markdown
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -324,23 +324,23 @@ The following arguments are supported:
324
324
-`type` - (Optional) The type of object model. Valid value:
325
325
-`MonitorsLibraryMonitor`
326
326
-`name` - (Required) The name of the monitor. The name must be alphanumeric.
327
-
-`description` - (Required) The description of the monitor.
327
+
-`description` - (Optional) The description of the monitor.
328
328
-`is_disabled` - (Optional) Whether or not the monitor is disabled. Disabled monitors will not run and will not generate or send notifications.
329
329
-`parent_id` - (Optional) The ID of the Monitor Folder that contains this monitor. Defaults to the root folder.
330
330
-`content_type` - (Optional) The type of the content object. Valid value:
331
331
-`Monitor`
332
332
-`monitor_type` - (Required) The type of monitor. Valid values:
333
333
-`Logs`: A logs query monitor.
334
334
-`Metrics`: A metrics query monitor.
335
-
-`Slo`: A SLO based monitor (beta).
335
+
-`Slo`: A SLO based monitor.
336
336
-`evaluation_delay` - (Optional) Evaluation delay as a string consists of the following elements:
337
337
1. `<number>`: number of time units,
338
338
2. `<time_unit>`: time unit; possible values are: `h` (hour), `m` (minute), `s` (second).
339
339
340
340
Multiple pairs of `<number><time_unit>` may be provided. For example,
341
341
`2m50s` means 2 minutes and 50 seconds.
342
342
-`slo_id` - (Optional) Identifier of the SLO definition for the monitor. This is only applicable & required for Slo `monitor_type`.
343
-
-`queries` - (Required) All queries from the monitor.
343
+
-`queries` - (Required if `monitor_type` is not `Slo`) All queries from the monitor.
344
344
-`trigger_conditions` - (Required if not using `triggers`) Defines the conditions of when to send notifications. NOTE: `trigger_conditions` supplants the `triggers` argument.
345
345
-`resolution_window` - The resolution window that the recovery condition must be met in each evaluation that happens within this entire duration before the alert is recovered (resolved). If not specified, the time range of your trigger will be used.
346
346
-`triggers` - (Deprecated) Defines the conditions of when to send notifications.
Copy file name to clipboardExpand all lines: website/docs/r/slo.html.markdown
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,6 @@ The following arguments are supported:
154
154
, `Other`. Defaults to `Latency`.
155
155
-`service` - (Optional) Name of the service.
156
156
-`application` - (Optional) Name of the application.
157
-
Defaults to true.
158
157
-`compliance` - (Required) The compliance settings for the SLO.
159
158
-`compliance_type` - (Required) The type of compliance to use. Valid values are `Rolling` or `Calendar`.
160
159
-`target` - (Required) Target percentage for the SLI over the compliance period. Must be a number between 0 and 100.
@@ -171,18 +170,18 @@ The following arguments are supported:
171
170
-[window_based_evaluation](#window_based_evaluation) - Evaluate SLI using successful/total windows.
172
171
-[request_based_evaluation](#request_based_evaluation) - Evaluate SLI based on occurrence of successful
173
172
events / total events over entire compliance period.
173
+
-[monitor_based_evaluation](#monitor_based_evaluation) - SLIs for Monitor-based SLOs are calculated at a granularity of 1 minute. A minute is treated as unsuccessful if the Monitor threshold is violated at any point of time within that minute.
174
174
175
175
#### window_based_evaluation
176
176
177
-
-`size` - (Required) The size of the window to use, minimum of `1m` and maximum of `1h`. Only applicable for Window
178
-
based evaluation.
177
+
-`size` - (Required) The size of the window to use, minimum of `1m` and maximum of `1h`.
179
178
-`query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
180
179
-`threshold` - (Required) Threshold for classifying window as successful or unsuccessful, i.e. the minimum value
181
180
for `(good windows / total windows) * 100`.
182
181
-`op` - (Required) The operator used to define a successful window. Valid values are `LessThan`
183
182
, `LessThanOrEqual`, `GreaterThan`
184
183
, `GreaterThanOrEqual`.
185
-
-`aggregation` - (Optional) Aggregation function applied over each window to arrive at SLI. Valid values are `Avg`
184
+
-`aggregation` - (Required if `query_group_type` is `Threshold`) Aggregation function applied over each window to arrive at SLI. Valid values are `Avg`
186
185
, `Sum`, `Count`, `Max`, `Min` and `p[1-99]`.
187
186
-`queries` - (Required) The queries to use.
188
187
-`query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
@@ -197,8 +196,8 @@ The following arguments are supported:
197
196
#### request_based_evaluation
198
197
199
198
-`query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
200
-
-`threshold` - (Required) Compared against threshold query's raw data points to determine success criteria.
201
-
-`op` - (Required) Comparison function with threshold. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
199
+
-`threshold` - (Required if `query_group_type` is `Threshold`) Compared against threshold query's raw data points to determine success criteria.
200
+
-`op` - (Required if `query_group_type` is `Threshold`) Comparison function with threshold. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
202
201
, `GreaterThanOrEqual`.
203
202
-`queries` - (Required) The queries to use.
204
203
-`query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
0 commit comments