Skip to content

Commit deb61e2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
SLO-3271: Update documentation for the transitions returned by SLO history (#2284)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent f366706 commit deb61e2

File tree

4 files changed

+59
-16
lines changed

4 files changed

+59
-16
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-05-14 14:47:45.391704",
8-
"spec_repo_commit": "48746015"
7+
"regenerated": "2024-05-14 16:40:02.086463",
8+
"spec_repo_commit": "45952461"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-05-14 14:47:45.409386",
13-
"spec_repo_commit": "48746015"
12+
"regenerated": "2024-05-14 16:40:02.105876",
13+
"spec_repo_commit": "45952461"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10661,9 +10661,24 @@ components:
1066110661
example: name
1066210662
type: string
1066310663
history:
10664-
description: For `monitor` based SLOs, this includes the aggregated history
10665-
as arrays that include timeseries and uptime data where `0=monitor` is
10666-
in `OK` state and `1=monitor` is in `alert` state.
10664+
description: 'The state transition history for the monitor. It is represented
10665+
as
10666+
10667+
an array of pairs. Each pair is an array containing the timestamp of the
10668+
transition
10669+
10670+
as an integer in Unix epoch format in the first element, and the state
10671+
as an integer in the
10672+
10673+
second element. An integer value of `0` for state means uptime, `1` means
10674+
downtime, and `2` means no data.
10675+
10676+
Periods of no data are counted either as uptime or downtime depending
10677+
on monitor settings.
10678+
10679+
See [SLO documentatio](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10680+
10681+
for detailed information.'
1066710682
example:
1066810683
- - 1579212382
1066910684
- 0
@@ -10843,9 +10858,26 @@ components:
1084310858
example: name
1084410859
type: string
1084510860
history:
10846-
description: For `monitor` based SLOs, this includes the aggregated history
10847-
as arrays that include timeseries and uptime data where `0=monitor` is
10848-
in `OK` state and `1=monitor` is in `alert` state.
10861+
description: 'The state transition history for `monitor` or `time-slice`
10862+
SLOs. It is represented as
10863+
10864+
an array of pairs. Each pair is an array containing the timestamp of the
10865+
transition
10866+
10867+
as an integer in Unix epoch format in the first element, and the state
10868+
as an integer in the
10869+
10870+
second element. An integer value of `0` for state means uptime, `1` means
10871+
downtime, and `2` means no data.
10872+
10873+
Periods of no data count as uptime in time-slice SLOs, while for monitor
10874+
SLOs, no data is counted
10875+
10876+
either as uptime or downtime depending on monitor settings. See
10877+
10878+
[SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10879+
10880+
for detailed information.'
1084910881
example:
1085010882
- - 1579212382
1085110883
- 0

src/main/java/com/datadog/api/client/v1/model/SLOHistoryMonitor.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,14 @@ public SLOHistoryMonitor addHistoryItem(List<Double> historyItem) {
177177
}
178178

179179
/**
180-
* For <code>monitor</code> based SLOs, this includes the aggregated history as arrays that
181-
* include timeseries and uptime data where <code>0=monitor</code> is in <code>OK</code> state and
182-
* <code>1=monitor</code> is in <code>alert</code> state.
180+
* The state transition history for the monitor. It is represented as an array of pairs. Each pair
181+
* is an array containing the timestamp of the transition as an integer in Unix epoch format in
182+
* the first element, and the state as an integer in the second element. An integer value of
183+
* <code>0</code> for state means uptime, <code>1</code> means downtime, and <code>2</code> means
184+
* no data. Periods of no data are counted either as uptime or downtime depending on monitor
185+
* settings. See <a
186+
* href="https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data">SLO
187+
* documentatio</a> for detailed information.
183188
*
184189
* @return history
185190
*/

src/main/java/com/datadog/api/client/v1/model/SLOHistorySLIData.java

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,15 @@ public SLOHistorySLIData addHistoryItem(List<Double> historyItem) {
177177
}
178178

179179
/**
180-
* For <code>monitor</code> based SLOs, this includes the aggregated history as arrays that
181-
* include timeseries and uptime data where <code>0=monitor</code> is in <code>OK</code> state and
182-
* <code>1=monitor</code> is in <code>alert</code> state.
180+
* The state transition history for <code>monitor</code> or <code>time-slice</code> SLOs. It is
181+
* represented as an array of pairs. Each pair is an array containing the timestamp of the
182+
* transition as an integer in Unix epoch format in the first element, and the state as an integer
183+
* in the second element. An integer value of <code>0</code> for state means uptime, <code>1
184+
* </code> means downtime, and <code>2</code> means no data. Periods of no data count as uptime in
185+
* time-slice SLOs, while for monitor SLOs, no data is counted either as uptime or downtime
186+
* depending on monitor settings. See <a
187+
* href="https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data">SLO
188+
* documentation</a> for detailed information.
183189
*
184190
* @return history
185191
*/

0 commit comments

Comments
 (0)