Skip to content

Add timeWindow type changes to slo docs #163367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wandergeek merged 4 commits into from
Aug 11, 2023
Merged

Add timeWindow type changes to slo docs #163367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
171df42
Add timeWindow type changes to slo docs
wandergeek Aug 7, 2023
6ee2af8
Update x-pack/plugins/observability/dev_docs/slo.md
wandergeek Aug 8, 2023
0a98d19
Add more clarification to timeWindow and missed type definitions to s…
wandergeek Aug 8, 2023
ea0fc69
Merge branch 'main' into doc-edit
wandergeek Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion x-pack/plugins/observability/dev_docs/composite_slo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ curl --request POST \
],
"timeWindow": {
"duration": "7d",
"isRolling": true
Copy link
Contributor

@kdelemme kdelemme Aug 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw, we are probably going to remove the composite_slo related feature as it is now

"type": "rolling"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down
26 changes: 13 additions & 13 deletions x-pack/plugins/observability/dev_docs/slo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The **custom Metric** SLI requires an index pattern, an optional filter query, a

We support **calendar aligned** and **rolling** time windows. Any duration greater than 1 day can be used: days, weeks, months, quarters, years.

**Rolling time window:** Requires a duration, e.g. `1w` for one week, and `isRolling: true`. SLOs defined with such time window, will only considere the SLI data from the last duration period as a moving window.
**Rolling time window:** Requires a duration, e.g. `1w` for one week, and `type: rolling`. SLOs defined with such time window, will only considere the SLI data from the last duration period as a moving window.

**Calendar aligned time window:** Requires a duration, limited to `1M` for monthly or `1w` for weekly, and `isCalendar: true`.
**Calendar aligned time window:** Requires a duration, limited to `1M` for monthly or `1w` for weekly, and `type: calendarAligned`.

### Budgeting method

Expand All @@ -46,8 +46,8 @@ If a **timeslices** budgeting method is used, we also need to define the **times

The default settings should be sufficient for most users, but if needed, the following properties can be overwritten:

- **syncDelay**: The ingest delay in the source data
- **frequency**: How often do we query the source data
- **syncDelay**: The ingest delay in the source data, defaults to `1m`
- **frequency**: How often do we query the source data, defaults to `1m`

## Example

Expand Down Expand Up @@ -77,7 +77,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "30d",
"isRolling": true
"type": "rolling"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down Expand Up @@ -112,7 +112,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "1M",
"isCalendar": true
"type": "calendarAligned"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down Expand Up @@ -146,8 +146,8 @@ curl --request POST \
}
},
"timeWindow": {
"duration": "1w",
"isRolling": true
"duration": "7d",
"type": "rolling"
},
"budgetingMethod": "timeslices",
"objective": {
Expand Down Expand Up @@ -187,7 +187,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "7d",
"isRolling": true
"type": "rolling"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down Expand Up @@ -223,7 +223,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "7d",
"isRolling": true
"type": "rolling"
},
"budgetingMethod": "timeslices",
"objective": {
Expand Down Expand Up @@ -261,7 +261,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "1w",
"isCalendar": true
"type": "calendarAligned"
},
"budgetingMethod": "timeslices",
"objective": {
Expand Down Expand Up @@ -300,7 +300,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "7d",
"isRolling": true
"type": "rolling"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down Expand Up @@ -355,7 +355,7 @@ curl --request POST \
},
"timeWindow": {
"duration": "7d",
"isRolling": true
"type": "rolling"
},
"budgetingMethod": "occurrences",
"objective": {
Expand Down