fix(slo): calendar aligned time window dev documentation (#157890)

This commit is contained in:
Kevin Delemme 2023-05-16 12:30:18 -04:00 committed by GitHub
parent b35265b96c
commit 712111fb15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 10 deletions

View file

@ -22,7 +22,7 @@ We support **calendar aligned** and **rolling** time windows. Any duration great
**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.
**Calendar aligned time window:** Requires a duration, e.g. `1M` for one month, and a `calendar.startTime` date in ISO 8601 in UTC, which marks the beginning of the first period. From start time and the duration, the system will compute the different time windows. For example, starting the calendar on the **01/01/2022** with a monthly duration, if today is the **24/10/2022**, the window associated is: `[2022-10-01T00:00:00Z, 2022-11-01T00:00:00Z]`
**Calendar aligned time window:** Requires a duration, limited to `1M` for monthly or `1w` for weekly, and `isCalendar: true`.
### Budgeting method
@ -86,7 +86,7 @@ curl --request POST \
</details>
<details>
<summary>95% availability for GET /api quarterly aligned</summary>
<summary>95% availability for GET /api monthly aligned</summary>
```
curl --request POST \
@ -108,10 +108,8 @@ curl --request POST \
}
},
"timeWindow": {
"duration": "1q",
"calendar": {
"startTime": "2022-06-01T00:00:00.000Z"
}
"duration": "1M",
"isCalendar": true
},
"budgetingMethod": "occurrences",
"objective": {
@ -259,10 +257,8 @@ curl --request POST \
}
},
"timeWindow": {
"duration": "7d",
"calendar": {
"startTime": "2022-01-01T00:00:00.000Z"
}
"duration": "1w",
"isCalendar": true
},
"budgetingMethod": "timeslices",
"objective": {

View file

@ -460,6 +460,7 @@ components:
- transactionType
- transactionName
- index
- threshold
properties:
service:
description: The APM service name
@ -485,6 +486,10 @@ components:
description: The index used by APM metrics
type: string
example: metrics-apm*,apm*
threshold:
description: The latency threshold in milliseconds
type: number
example: 250
type:
description: The type of indicator.
type: string

View file

@ -15,6 +15,7 @@ properties:
- transactionType
- transactionName
- index
- threshold
properties:
service:
description: The APM service name
@ -40,6 +41,10 @@ properties:
description: The index used by APM metrics
type: string
example: metrics-apm*,apm*
threshold:
description: The latency threshold in milliseconds
type: number
example: 250
type:
description: The type of indicator.
type: string