Skip to content

Commit c9b24cb

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Regenerate client from commit 53a6366 of spec repo (#3530)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 6378798 commit c9b24cb

File tree

10 files changed

+814
-199
lines changed

10 files changed

+814
-199
lines changed

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12338,33 +12338,73 @@ components:
1233812338
type: object
1233912339
SLOCountDefinition:
1234012340
description: 'A count-based (metric) SLI specification, composed of three parts:
12341-
the good events formula, the total events formula,
12341+
the good events formula,
1234212342

12343-
and the underlying queries.'
12343+
the bad or total events formula, and the underlying queries.
12344+
12345+
Exactly one of `total_events_formula` or `bad_events_formula` must be provided.'
1234412346
example:
12345-
good_events_formula: query1 - query2
12347+
bad_events_formula: query2
12348+
good_events_formula: query1
1234612349
queries:
1234712350
- data_source: metrics
1234812351
name: query1
12349-
query: sum:trace.servlet.request.hits{*} by {env}.as_count()
12352+
query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()
1235012353
- data_source: metrics
1235112354
name: query2
12352-
query: sum:trace.servlet.request.errors{*} by {env}.as_count()
12353-
total_events_formula: query1
12355+
query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()
12356+
oneOf:
12357+
- $ref: '#/components/schemas/SLOCountDefinitionWithTotalEventsFormula'
12358+
- $ref: '#/components/schemas/SLOCountDefinitionWithBadEventsFormula'
12359+
SLOCountDefinitionWithBadEventsFormula:
12360+
additionalProperties: false
1235412361
properties:
12362+
bad_events_formula:
12363+
$ref: '#/components/schemas/SLOFormula'
12364+
description: The bad events formula (recommended). Total events queries
12365+
can be defined using the `total_events_formula` field as an alternative.
12366+
Only one of `total_events_formula` or `bad_events_formula` must be provided.
1235512367
good_events_formula:
1235612368
$ref: '#/components/schemas/SLOFormula'
1235712369
queries:
1235812370
example:
1235912371
- data_source: metrics
1236012372
name: query1
12361-
query: sum:trace.servlet.request.hits{*} by {env}.as_count()
12373+
query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()
12374+
- data_source: metrics
12375+
name: query2
12376+
query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()
12377+
items:
12378+
$ref: '#/components/schemas/SLODataSourceQueryDefinition'
12379+
minItems: 1
12380+
type: array
12381+
required:
12382+
- good_events_formula
12383+
- bad_events_formula
12384+
- queries
12385+
type: object
12386+
SLOCountDefinitionWithTotalEventsFormula:
12387+
additionalProperties: false
12388+
properties:
12389+
good_events_formula:
12390+
$ref: '#/components/schemas/SLOFormula'
12391+
queries:
12392+
example:
12393+
- data_source: metrics
12394+
name: query1
12395+
query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()
12396+
- data_source: metrics
12397+
name: query2
12398+
query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()
1236212399
items:
1236312400
$ref: '#/components/schemas/SLODataSourceQueryDefinition'
1236412401
minItems: 1
1236512402
type: array
1236612403
total_events_formula:
1236712404
$ref: '#/components/schemas/SLOFormula'
12405+
description: The total events formula. Bad events queries can be defined
12406+
using the `bad_events_formula` field as an alternative. Only one of `total_events_formula`
12407+
or `bad_events_formula` must be provided.
1236812408
required:
1236912409
- good_events_formula
1237012410
- total_events_formula
@@ -12375,15 +12415,15 @@ components:
1237512415
description: A metric SLI specification.
1237612416
example:
1237712417
count:
12378-
good_events_formula: query1 - query2
12418+
bad_events_formula: query2
12419+
good_events_formula: query1
1237912420
queries:
1238012421
- data_source: metrics
1238112422
name: query1
12382-
query: sum:trace.servlet.request.hits{*} by {env}.as_count()
12423+
query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()
1238312424
- data_source: metrics
1238412425
name: query2
12385-
query: sum:trace.servlet.request.errors{*} by {env}.as_count()
12386-
total_events_formula: query1
12426+
query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()
1238712427
properties:
1238812428
count:
1238912429
$ref: '#/components/schemas/SLOCountDefinition'
@@ -13519,7 +13559,7 @@ components:
1351913559
name: query1
1352013560
query: sum:trace.servlet.request.hits{*} by {env}.as_count()
1352113561
- data_source: metrics
13522-
name: query1
13562+
name: query2
1352313563
query: sum:trace.servlet.request.errors{*} by {env}.as_count()
1352413564
threshold: 5
1352513565
properties:

‎examples/v1/service-level-objectives/CreateSLO_512760759.java‎

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
77
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
88
import com.datadog.api.client.v1.model.SLOCountDefinition;
9+
import com.datadog.api.client.v1.model.SLOCountDefinitionWithTotalEventsFormula;
910
import com.datadog.api.client.v1.model.SLOCountSpec;
1011
import com.datadog.api.client.v1.model.SLODataSourceQueryDefinition;
1112
import com.datadog.api.client.v1.model.SLOFormula;
@@ -32,23 +33,25 @@ public static void main(String[] args) {
3233
new SLOSliSpec(
3334
new SLOCountSpec()
3435
.count(
35-
new SLOCountDefinition()
36-
.goodEventsFormula(new SLOFormula().formula("query1 - query2"))
37-
.totalEventsFormula(new SLOFormula().formula("query1"))
38-
.queries(
39-
Arrays.asList(
40-
new SLODataSourceQueryDefinition(
41-
new FormulaAndFunctionMetricQueryDefinition()
42-
.dataSource(
43-
FormulaAndFunctionMetricDataSource.METRICS)
44-
.name("query1")
45-
.query("sum:httpservice.hits{*}.as_count()")),
46-
new SLODataSourceQueryDefinition(
47-
new FormulaAndFunctionMetricQueryDefinition()
48-
.dataSource(
49-
FormulaAndFunctionMetricDataSource.METRICS)
50-
.name("query2")
51-
.query("sum:httpservice.errors{*}.as_count()")))))))
36+
new SLOCountDefinition(
37+
new SLOCountDefinitionWithTotalEventsFormula()
38+
.goodEventsFormula(new SLOFormula().formula("query1 - query2"))
39+
.totalEventsFormula(new SLOFormula().formula("query1"))
40+
.queries(
41+
Arrays.asList(
42+
new SLODataSourceQueryDefinition(
43+
new FormulaAndFunctionMetricQueryDefinition()
44+
.dataSource(
45+
FormulaAndFunctionMetricDataSource.METRICS)
46+
.name("query1")
47+
.query("sum:httpservice.hits{*}.as_count()")),
48+
new SLODataSourceQueryDefinition(
49+
new FormulaAndFunctionMetricQueryDefinition()
50+
.dataSource(
51+
FormulaAndFunctionMetricDataSource.METRICS)
52+
.name("query2")
53+
.query(
54+
"sum:httpservice.errors{*}.as_count()"))))))))
5255
.tags(Arrays.asList("env:prod", "type:count"))
5356
.thresholds(
5457
Collections.singletonList(

‎examples/v1/service-level-objectives/CreateSLO_707861409.java‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Create a new metric SLO object using bad events formula returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v1.api.ServiceLevelObjectivesApi;
6+
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
7+
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
8+
import com.datadog.api.client.v1.model.SLOCountDefinition;
9+
import com.datadog.api.client.v1.model.SLOCountDefinitionWithBadEventsFormula;
10+
import com.datadog.api.client.v1.model.SLOCountSpec;
11+
import com.datadog.api.client.v1.model.SLODataSourceQueryDefinition;
12+
import com.datadog.api.client.v1.model.SLOFormula;
13+
import com.datadog.api.client.v1.model.SLOListResponse;
14+
import com.datadog.api.client.v1.model.SLOSliSpec;
15+
import com.datadog.api.client.v1.model.SLOThreshold;
16+
import com.datadog.api.client.v1.model.SLOTimeframe;
17+
import com.datadog.api.client.v1.model.SLOType;
18+
import com.datadog.api.client.v1.model.ServiceLevelObjectiveRequest;
19+
import java.util.Arrays;
20+
import java.util.Collections;
21+
22+
public class Example {
23+
public static void main(String[] args) {
24+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
25+
ServiceLevelObjectivesApi apiInstance = new ServiceLevelObjectivesApi(defaultClient);
26+
27+
ServiceLevelObjectiveRequest body =
28+
new ServiceLevelObjectiveRequest()
29+
.type(SLOType.METRIC)
30+
.description("Metric SLO using sli_specification")
31+
.name("Example-Service-Level-Objective")
32+
.sliSpecification(
33+
new SLOSliSpec(
34+
new SLOCountSpec()
35+
.count(
36+
new SLOCountDefinition(
37+
new SLOCountDefinitionWithBadEventsFormula()
38+
.goodEventsFormula(new SLOFormula().formula("query1 - query2"))
39+
.badEventsFormula(new SLOFormula().formula("query2"))
40+
.queries(
41+
Arrays.asList(
42+
new SLODataSourceQueryDefinition(
43+
new FormulaAndFunctionMetricQueryDefinition()
44+
.dataSource(
45+
FormulaAndFunctionMetricDataSource.METRICS)
46+
.name("query1")
47+
.query("sum:httpservice.hits{*}.as_count()")),
48+
new SLODataSourceQueryDefinition(
49+
new FormulaAndFunctionMetricQueryDefinition()
50+
.dataSource(
51+
FormulaAndFunctionMetricDataSource.METRICS)
52+
.name("query2")
53+
.query(
54+
"sum:httpservice.errors{*}.as_count()"))))))))
55+
.tags(Arrays.asList("env:prod", "type:count"))
56+
.thresholds(
57+
Collections.singletonList(
58+
new SLOThreshold()
59+
.target(99.0)
60+
.targetDisplay("99.0")
61+
.timeframe(SLOTimeframe.SEVEN_DAYS)
62+
.warning(99.5)
63+
.warningDisplay("99.5")))
64+
.timeframe(SLOTimeframe.SEVEN_DAYS)
65+
.targetThreshold(99.0)
66+
.warningThreshold(99.5);
67+
68+
try {
69+
SLOListResponse result = apiInstance.createSLO(body);
70+
System.out.println(result);
71+
} catch (ApiException e) {
72+
System.err.println("Exception when calling ServiceLevelObjectivesApi#createSLO");
73+
System.err.println("Status code: " + e.getCode());
74+
System.err.println("Reason: " + e.getResponseBody());
75+
System.err.println("Response headers: " + e.getResponseHeaders());
76+
e.printStackTrace();
77+
}
78+
}
79+
}

0 commit comments

Comments
 (0)