Skip to content

Commit 47b0464

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Update distribution and heatmap's markers ,num_buckets properties and allowed request/query (#3292)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 0701270 commit 47b0464

21 files changed

+993
-47
lines changed

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

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,6 +1741,9 @@ components:
17411741
type: string
17421742
markers:
17431743
description: List of markers.
1744+
example:
1745+
- display_type: percentile
1746+
value: '90'
17441747
items:
17451748
$ref: '#/components/schemas/WidgetMarker'
17461749
type: array
@@ -1799,14 +1802,6 @@ components:
17991802
- $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
18001803
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition'
18011804
- $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
1802-
DistributionWidgetHistogramRequestType:
1803-
description: Request type for the histogram request.
1804-
enum:
1805-
- histogram
1806-
example: histogram
1807-
type: string
1808-
x-enum-varnames:
1809-
- HISTOGRAM
18101805
DistributionWidgetRequest:
18111806
description: Updated distribution widget.
18121807
properties:
@@ -1816,6 +1811,11 @@ components:
18161811
$ref: '#/components/schemas/ApmStatsQueryDefinition'
18171812
event_query:
18181813
$ref: '#/components/schemas/LogQueryDefinition'
1814+
formulas:
1815+
description: List of formulas that operate on queries.
1816+
items:
1817+
$ref: '#/components/schemas/WidgetFormula'
1818+
type: array
18191819
log_query:
18201820
$ref: '#/components/schemas/LogQueryDefinition'
18211821
network_query:
@@ -1827,10 +1827,17 @@ components:
18271827
q:
18281828
description: Widget query.
18291829
type: string
1830+
queries:
1831+
description: List of queries that can be returned directly or used in formulas.
1832+
items:
1833+
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
1834+
type: array
18301835
query:
18311836
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
18321837
request_type:
1833-
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
1838+
$ref: '#/components/schemas/WidgetHistogramRequestType'
1839+
response_format:
1840+
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
18341841
rum_query:
18351842
$ref: '#/components/schemas/LogQueryDefinition'
18361843
security_query:
@@ -1854,6 +1861,12 @@ components:
18541861
description: Specifies minimum value to show on the x-axis. It takes a number,
18551862
percentile (p90 === 90th percentile), or auto for default behavior.
18561863
type: string
1864+
num_buckets:
1865+
description: Number of value buckets to target, also known as the resolution
1866+
of the value bins.
1867+
format: int64
1868+
minimum: 1
1869+
type: integer
18571870
scale:
18581871
default: linear
18591872
description: Specifies the scale type. Possible values are `linear`.
@@ -3752,6 +3765,14 @@ components:
37523765
type: array
37533766
legend_size:
37543767
$ref: '#/components/schemas/WidgetLegendSize'
3768+
markers:
3769+
description: List of markers.
3770+
example:
3771+
- display_type: percentile
3772+
value: '90'
3773+
items:
3774+
$ref: '#/components/schemas/WidgetMarker'
3775+
type: array
37553776
requests:
37563777
description: List of widget types.
37573778
example:
@@ -3776,6 +3797,8 @@ components:
37763797
type: string
37773798
type:
37783799
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
3800+
xaxis:
3801+
$ref: '#/components/schemas/HeatMapWidgetXAxis'
37793802
yaxis:
37803803
$ref: '#/components/schemas/WidgetAxis'
37813804
required:
@@ -3819,6 +3842,10 @@ components:
38193842
items:
38203843
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
38213844
type: array
3845+
query:
3846+
$ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
3847+
request_type:
3848+
$ref: '#/components/schemas/WidgetHistogramRequestType'
38223849
response_format:
38233850
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
38243851
rum_query:
@@ -3828,6 +3855,19 @@ components:
38283855
style:
38293856
$ref: '#/components/schemas/WidgetStyle'
38303857
type: object
3858+
HeatMapWidgetXAxis:
3859+
description: X Axis controls for the heat map widget.
3860+
properties:
3861+
num_buckets:
3862+
description: 'Number of time buckets to target, also known as the resolution
3863+
3864+
of the time bins. This is only applicable for distribution of
3865+
3866+
points (group distributions use the roll-up modifier).'
3867+
format: int64
3868+
minimum: 1
3869+
type: integer
3870+
type: object
38313871
Host:
38323872
description: Object representing a host.
38333873
properties:
@@ -25230,6 +25270,14 @@ components:
2523025270
x-enum-varnames:
2523125271
- CHECK
2523225272
- CLUSTER
25273+
WidgetHistogramRequestType:
25274+
description: Request type for the histogram request.
25275+
enum:
25276+
- histogram
25277+
example: histogram
25278+
type: string
25279+
x-enum-varnames:
25280+
- HISTOGRAM
2523325281
WidgetHorizontalAlign:
2523425282
description: Horizontal alignment.
2523525283
enum:
@@ -25434,7 +25482,7 @@ components:
2543425482
display_type:
2543525483
description: "Combination of:\n - A severity error, warning, ok, or info\n
2543625484
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
25437-
widget, this can be set to be `x_axis_percentile`."
25485+
widget, this can be set to be `percentile`."
2543825486
example: error dashed
2543925487
type: string
2544025488
label:
@@ -25445,8 +25493,13 @@ components:
2544525493
description: Timestamp for the widget.
2544625494
type: string
2544725495
value:
25448-
description: Value to apply. Can be a single value y = 15 or a range of
25496+
description: 'Value to apply. Can be a single value y = 15 or a range of
2544925497
values 0 < y < 10.
25498+
25499+
For Distribution widgets with `display_type` set to `percentile`, this
25500+
should be
25501+
25502+
a numeric percentile value (for example, "90" for P90).'
2545025503
example: y = 15
2545125504
type: string
2545225505
required:

‎examples/v1/dashboards/CreateDashboard_1093147852.java‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
// Create a new dashboard with distribution widget with markers and num_buckets
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v1.api.DashboardsApi;
6+
import com.datadog.api.client.v1.model.Dashboard;
7+
import com.datadog.api.client.v1.model.DashboardLayoutType;
8+
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
9+
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
10+
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
11+
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
12+
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
13+
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricAggregation;
14+
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
15+
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
16+
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
17+
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
18+
import com.datadog.api.client.v1.model.Widget;
19+
import com.datadog.api.client.v1.model.WidgetDefinition;
20+
import com.datadog.api.client.v1.model.WidgetLayout;
21+
import com.datadog.api.client.v1.model.WidgetMarker;
22+
import com.datadog.api.client.v1.model.WidgetTextAlign;
23+
import java.util.Arrays;
24+
import java.util.Collections;
25+
26+
public class Example {
27+
public static void main(String[] args) {
28+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
29+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
30+
31+
Dashboard body =
32+
new Dashboard()
33+
.title("Example-Dashboard")
34+
.widgets(
35+
Collections.singletonList(
36+
new Widget()
37+
.definition(
38+
new WidgetDefinition(
39+
new DistributionWidgetDefinition()
40+
.title("")
41+
.titleSize("16")
42+
.titleAlign(WidgetTextAlign.LEFT)
43+
.type(DistributionWidgetDefinitionType.DISTRIBUTION)
44+
.xaxis(
45+
new DistributionWidgetXAxis()
46+
.scale("linear")
47+
.min("auto")
48+
.max("auto")
49+
.includeZero(true)
50+
.numBuckets(55L))
51+
.yaxis(
52+
new DistributionWidgetYAxis()
53+
.scale("linear")
54+
.min("auto")
55+
.max("auto")
56+
.includeZero(true))
57+
.markers(
58+
Arrays.asList(
59+
new WidgetMarker()
60+
.displayType("percentile")
61+
.value("50"),
62+
new WidgetMarker()
63+
.displayType("percentile")
64+
.value("99"),
65+
new WidgetMarker()
66+
.displayType("percentile")
67+
.value("90")))
68+
.requests(
69+
Collections.singletonList(
70+
new DistributionWidgetRequest()
71+
.responseFormat(
72+
FormulaAndFunctionResponseFormat.SCALAR)
73+
.queries(
74+
Collections.singletonList(
75+
new FormulaAndFunctionQueryDefinition(
76+
new FormulaAndFunctionMetricQueryDefinition()
77+
.dataSource(
78+
FormulaAndFunctionMetricDataSource
79+
.METRICS)
80+
.name("query1")
81+
.query(
82+
"avg:system.cpu.user{*} by"
83+
+ " {service}")
84+
.aggregator(
85+
FormulaAndFunctionMetricAggregation
86+
.AVG))))))))
87+
.layout(new WidgetLayout().x(0L).y(0L).width(4L).height(4L))))
88+
.layoutType(DashboardLayoutType.ORDERED);
89+
90+
try {
91+
Dashboard result = apiInstance.createDashboard(body);
92+
System.out.println(result);
93+
} catch (ApiException e) {
94+
System.err.println("Exception when calling DashboardsApi#createDashboard");
95+
System.err.println("Status code: " + e.getCode());
96+
System.err.println("Reason: " + e.getResponseBody());
97+
System.err.println("Response headers: " + e.getResponseHeaders());
98+
e.printStackTrace();
99+
}
100+
}
101+
}

‎examples/v1/dashboards/CreateDashboard_1442588603.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
1010
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
1111
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
12-
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
1312
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
1413
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
1514
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
@@ -18,6 +17,7 @@
1817
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsQueryDefinition;
1918
import com.datadog.api.client.v1.model.Widget;
2019
import com.datadog.api.client.v1.model.WidgetDefinition;
20+
import com.datadog.api.client.v1.model.WidgetHistogramRequestType;
2121
import com.datadog.api.client.v1.model.WidgetLayout;
2222
import com.datadog.api.client.v1.model.WidgetStyle;
2323
import com.datadog.api.client.v1.model.WidgetTextAlign;
@@ -77,9 +77,7 @@ public static void main(String[] args) {
7777
.primaryTagName("datacenter")
7878
.operationName(
7979
"universal.http.client")))
80-
.requestType(
81-
DistributionWidgetHistogramRequestType
82-
.HISTOGRAM)
80+
.requestType(WidgetHistogramRequestType.HISTOGRAM)
8381
.style(new WidgetStyle().palette("dog_classic"))))))
8482
.layout(new WidgetLayout().x(8L).y(0L).width(4L).height(2L))))
8583
.layoutType(DashboardLayoutType.ORDERED);

‎examples/v1/dashboards/CreateDashboard_1617893815.java‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
// Create a new dashboard with formula and function distribution widget
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v1.api.DashboardsApi;
6+
import com.datadog.api.client.v1.model.Dashboard;
7+
import com.datadog.api.client.v1.model.DashboardLayoutType;
8+
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
9+
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
10+
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
11+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
12+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
13+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
14+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
15+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBy;
16+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBySort;
17+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
18+
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
19+
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
20+
import com.datadog.api.client.v1.model.QuerySortOrder;
21+
import com.datadog.api.client.v1.model.Widget;
22+
import com.datadog.api.client.v1.model.WidgetDefinition;
23+
import com.datadog.api.client.v1.model.WidgetLayout;
24+
import com.datadog.api.client.v1.model.WidgetLegacyLiveSpan;
25+
import com.datadog.api.client.v1.model.WidgetTextAlign;
26+
import com.datadog.api.client.v1.model.WidgetTime;
27+
import java.util.Collections;
28+
29+
public class Example {
30+
public static void main(String[] args) {
31+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
32+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
33+
34+
Dashboard body =
35+
new Dashboard()
36+
.title("Example-Dashboard")
37+
.widgets(
38+
Collections.singletonList(
39+
new Widget()
40+
.layout(new WidgetLayout().x(0L).y(0L).width(47L).height(15L))
41+
.definition(
42+
new WidgetDefinition(
43+
new DistributionWidgetDefinition()
44+
.title("")
45+
.titleSize("16")
46+
.titleAlign(WidgetTextAlign.LEFT)
47+
.time(new WidgetTime(new WidgetLegacyLiveSpan()))
48+
.type(DistributionWidgetDefinitionType.DISTRIBUTION)
49+
.requests(
50+
Collections.singletonList(
51+
new DistributionWidgetRequest()
52+
.responseFormat(
53+
FormulaAndFunctionResponseFormat.SCALAR)
54+
.queries(
55+
Collections.singletonList(
56+
new FormulaAndFunctionQueryDefinition(
57+
new FormulaAndFunctionEventQueryDefinition()
58+
.dataSource(
59+
FormulaAndFunctionEventsDataSource
60+
.LOGS)
61+
.name("query1")
62+
.search(
63+
new FormulaAndFunctionEventQueryDefinitionSearch()
64+
.query(""))
65+
.indexes(
66+
Collections.singletonList("*"))
67+
.compute(
68+
new FormulaAndFunctionEventQueryDefinitionCompute()
69+
.aggregation(
70+
FormulaAndFunctionEventAggregation
71+
.AVG)
72+
.metric("@duration"))
73+
.groupBy(
74+
Collections.singletonList(
75+
new FormulaAndFunctionEventQueryGroupBy()
76+
.facet("service")
77+
.limit(1000L)
78+
.sort(
79+
new FormulaAndFunctionEventQueryGroupBySort()
80+
.aggregation(
81+
FormulaAndFunctionEventAggregation
82+
.COUNT)
83+
.order(
84+
QuerySortOrder
85+
.DESC))))
86+
.storage("hot"))))))))))
87+
.layoutType(DashboardLayoutType.FREE);
88+
89+
try {
90+
Dashboard result = apiInstance.createDashboard(body);
91+
System.out.println(result);
92+
} catch (ApiException e) {
93+
System.err.println("Exception when calling DashboardsApi#createDashboard");
94+
System.err.println("Status code: " + e.getCode());
95+
System.err.println("Reason: " + e.getResponseBody());
96+
System.err.println("Response headers: " + e.getResponseHeaders());
97+
e.printStackTrace();
98+
}
99+
}
100+
}

0 commit comments

Comments
 (0)