Skip to content

Commit 51bf685

Browse files
author
Ashish Gaurav
committed
[SLOs] review fixes in slo docs
Took 2 minutes
1 parent 462628f commit 51bf685

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

website/docs/r/slo.html.markdown

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -57,45 +57,47 @@ The following arguments are supported:
5757
- `compliance_type` - (Required) The type of compliance to use. Valid values are `Rolling` or `Calendar`.
5858
- `target` - (Required) The target value to use, must be a number between 0 and 100.
5959
- `timezone` - (Required) Time zone for the SLO compliance. Follow the format in the [IANA Time Zone Database][3].
60-
- `size` - (Required) The size of the compliance period to use. For `Rolling` compliance type, the minimum of `1d` and maximum of `14d` are allowed.
60+
- `size` - (Required) The size of the compliance period to use.
6161
For `Calendar` compliance type the allowed values are `Week`, `Month`, `Quarter`.
6262
- `start_from` - (Optional) Start of the calendar window. For week, it would be the day of the week (for e.g Sunday, Monday etc). For month, it will always be the first day of the month. For quarter, it would be the first month of the quarter (for e.g January, February etc.)
6363
- `indicator` - (Required) The service level indicator on which SLO is to be defined. more details on the difference b/w them can be found on the [slo help page](https://help.sumologic.com/Beta/SLO_Reliability_Management/Access_and_Create_SLOs)
6464
- [window_based_evaluation](#window_based_evaluation) - Evaluate SLI using successful/total windows.
6565
- [request_based_evaluation](#request_based_evaluation) - Evaluate SLI based on occurrence's of successful events / total events over entire compliance period.
6666

6767
#### window_based_evaluation
68-
- `size` - (Required) The size of the window to use, minimum of `1m` and maximum of `1h`. Only applicable for Window based evaluation.
69-
- `query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
70-
- `threshold` - (Required) Threshold for classifying window as successful or unsuccessful, i.e. the minimum value for `good windows / total events`.
71-
- `op` - (Required) The operator used to define a successful window or event. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
72-
, `GreaterThanOrEqual`.
73-
- `aggregation` - (Optional) Aggregation function applied over each window to arrive at SLI. Valid values are `Avg`
74-
, `Sum`, `Count`, `Max`, `Min` and `p[1-99]`.
75-
- `queries` - (Required) The queries to use.
76-
- `query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
77-
, `Threshold`.
78-
- `query_group` - (Required) List of queries to use.
79-
- `row_id` - (Required) The row ID to use.
80-
- `query` - (Required) The query string to use.
81-
- `use_row_count` - (Required) Whether to use the row count. Defaults to false.
82-
- `field` - (Optional) Field of log query output to compare against. To be used only for logs based data
83-
type when `use_row_count` is false.
68+
69+
- `size` - (Required) The size of the window to use, minimum of `1m` and maximum of `1h`. Only applicable for Window based evaluation.
70+
- `query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
71+
- `threshold` - (Required) Threshold for classifying window as successful or unsuccessful, i.e. the minimum value for `good windows / total events`.
72+
- `op` - (Required) The operator used to define a successful window or event. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
73+
, `GreaterThanOrEqual`.
74+
- `aggregation` - (Optional) Aggregation function applied over each window to arrive at SLI. Valid values are `Avg`
75+
, `Sum`, `Count`, `Max`, `Min` and `p[1-99]`.
76+
- `queries` - (Required) The queries to use.
77+
- `query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
78+
, `Threshold`.
79+
- `query_group` - (Required) List of queries to use.
80+
- `row_id` - (Required) The row ID to use.
81+
- `query` - (Required) The query string to use.
82+
- `use_row_count` - (Required) Whether to use the row count. Defaults to false.
83+
- `field` - (Optional) Field of log query output to compare against. To be used only for logs based data
84+
type when `use_row_count` is false.
8485

8586
#### request_based_evaluation
86-
- `query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
87-
- `threshold` - (Required) Compared against threshold query's raw data points to determine success criteria.
88-
- `op` - (Required) Comparison function with threshold. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
89-
, `GreaterThanOrEqual`.
90-
- `queries` - (Required) The queries to use.
91-
- `query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
92-
, `Threshold`.
93-
- `query_group` - (Required) List of queries to use.
94-
- `row_id` - (Required) The row ID to use.
95-
- `query` - (Required) The query string to use.
96-
- `use_row_count` - (Required) Whether to use the row count. Defaults to false.
97-
- `field` - (Optional) Field of log query output to compare against. To be used only for logs based data
98-
type when `use_row_count` is false.
87+
88+
- `query_type` - (Required) The type of query to use. Valid values are `Metrics` or `Logs`.
89+
- `threshold` - (Required) Compared against threshold query's raw data points to determine success criteria.
90+
- `op` - (Required) Comparison function with threshold. Valid values are `LessThan`, `LessThanOrEqual`, `GreaterThan`
91+
, `GreaterThanOrEqual`.
92+
- `queries` - (Required) The queries to use.
93+
- `query_group_type` - (Required) The type of query. Valid values are `Successful`, `Unsuccessful`, `Total`
94+
, `Threshold`.
95+
- `query_group` - (Required) List of queries to use.
96+
- `row_id` - (Required) The row ID to use.
97+
- `query` - (Required) The query string to use.
98+
- `use_row_count` - (Required) Whether to use the row count. Defaults to false.
99+
- `field` - (Optional) Field of log query output to compare against. To be used only for logs based data
100+
type when `use_row_count` is false.
99101

100102
[1]: https://help.sumologic.com/Beta/SLO_Reliability_Management
101103

0 commit comments

Comments
 (0)