Skip to content

Add Heatgrid dashboard widget support #4439

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
dd-octo-sts merged 1 commit into from
Oct 9, 2026
Merged

Add Heatgrid dashboard widget support #4439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
397 changes: 397 additions & 0 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

109 changes: 109 additions & 0 deletions examples/v1/dashboards/CreateDashboard_1322784076.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
// Create a heatgrid widget with custom discrete thresholds

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.HeatgridColor;
import com.datadog.api.client.v1.model.HeatgridColorBin;
import com.datadog.api.client.v1.model.HeatgridColorConfig;
import com.datadog.api.client.v1.model.HeatgridCustomColorSource;
import com.datadog.api.client.v1.model.HeatgridDiscreteCustomColor;
import com.datadog.api.client.v1.model.HeatgridDiscreteMode;
import com.datadog.api.client.v1.model.HeatgridLabelColumn;
import com.datadog.api.client.v1.model.HeatgridLabelColumnWidth;
import com.datadog.api.client.v1.model.HeatgridLegend;
import com.datadog.api.client.v1.model.HeatgridNestingDisplay;
import com.datadog.api.client.v1.model.HeatgridSort;
import com.datadog.api.client.v1.model.HeatgridSortBy;
import com.datadog.api.client.v1.model.HeatgridSortByLabel;
import com.datadog.api.client.v1.model.HeatgridSortByLabelProperty;
import com.datadog.api.client.v1.model.HeatgridSortOrder;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinition;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinitionType;
import com.datadog.api.client.v1.model.HeatgridWidgetFormula;
import com.datadog.api.client.v1.model.HeatgridWidgetRequest;
import com.datadog.api.client.v1.model.HeatgridWidgetResponseFormat;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
DashboardsApi apiInstance = new DashboardsApi(defaultClient);

Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.layoutType(DashboardLayoutType.ORDERED)
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new HeatgridWidgetDefinition()
.type(HeatgridWidgetDefinitionType.HEATGRID)
.requests(
Collections.singletonList(
new HeatgridWidgetRequest()
.responseFormat(
HeatgridWidgetResponseFormat.TIMESERIES)
.queries(
Collections.singletonList(
new FormulaAndFunctionQueryDefinition(
new FormulaAndFunctionMetricQueryDefinition()
.dataSource(
FormulaAndFunctionMetricDataSource
.METRICS)
.name("query1")
.query(
"avg:system.cpu.user{*} by"
+ " {host}"))))
.formulas(
Collections.singletonList(
new HeatgridWidgetFormula()
.formula("query1")))))
.sort(
new HeatgridSort()
.nestingDisplay(HeatgridNestingDisplay.FLAT)
.sortBy(
new HeatgridSortBy(
new HeatgridSortByLabel()
.property(HeatgridSortByLabelProperty.LABEL)
.order(HeatgridSortOrder.ASC))))
.color(
new HeatgridColorConfig(
new HeatgridDiscreteCustomColor()
.mode(HeatgridDiscreteMode.DISCRETE)
.source(HeatgridCustomColorSource.CUSTOM)
.bins(
Arrays.asList(
new HeatgridColorBin()
.color(new HeatgridColor("#00FF00")),
new HeatgridColorBin()
.color(new HeatgridColor("#FF0000"))
.lowerBound(80.0)))))
.legend(new HeatgridLegend().showCaption(true))
.labelColumn(
new HeatgridLabelColumn()
.width(HeatgridLabelColumnWidth.M))))));

try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
115 changes: 115 additions & 0 deletions examples/v1/dashboards/CreateDashboard_1681529203.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
// Create a heatgrid widget with custom gradient colors for both themes

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.HeatgridColor;
import com.datadog.api.client.v1.model.HeatgridColorConfig;
import com.datadog.api.client.v1.model.HeatgridColorStop;
import com.datadog.api.client.v1.model.HeatgridCustomColorSource;
import com.datadog.api.client.v1.model.HeatgridGradientCustomColor;
import com.datadog.api.client.v1.model.HeatgridGradientMode;
import com.datadog.api.client.v1.model.HeatgridLabelColumn;
import com.datadog.api.client.v1.model.HeatgridLabelColumnWidth;
import com.datadog.api.client.v1.model.HeatgridLegend;
import com.datadog.api.client.v1.model.HeatgridNestingDisplay;
import com.datadog.api.client.v1.model.HeatgridSort;
import com.datadog.api.client.v1.model.HeatgridSortAggregation;
import com.datadog.api.client.v1.model.HeatgridSortBy;
import com.datadog.api.client.v1.model.HeatgridSortByValue;
import com.datadog.api.client.v1.model.HeatgridSortByValueProperty;
import com.datadog.api.client.v1.model.HeatgridSortOrder;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinition;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinitionType;
import com.datadog.api.client.v1.model.HeatgridWidgetFormula;
import com.datadog.api.client.v1.model.HeatgridWidgetRequest;
import com.datadog.api.client.v1.model.HeatgridWidgetResponseFormat;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
DashboardsApi apiInstance = new DashboardsApi(defaultClient);

Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.layoutType(DashboardLayoutType.ORDERED)
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new HeatgridWidgetDefinition()
.type(HeatgridWidgetDefinitionType.HEATGRID)
.requests(
Collections.singletonList(
new HeatgridWidgetRequest()
.responseFormat(
HeatgridWidgetResponseFormat.TIMESERIES)
.queries(
Collections.singletonList(
new FormulaAndFunctionQueryDefinition(
new FormulaAndFunctionMetricQueryDefinition()
.dataSource(
FormulaAndFunctionMetricDataSource
.METRICS)
.name("query1")
.query(
"avg:system.cpu.user{*} by"
+ " {host}"))))
.formulas(
Collections.singletonList(
new HeatgridWidgetFormula()
.formula("query1")))))
.sort(
new HeatgridSort()
.nestingDisplay(HeatgridNestingDisplay.FLAT)
.sortBy(
new HeatgridSortBy(
new HeatgridSortByValue()
.property(HeatgridSortByValueProperty.VALUE)
.order(HeatgridSortOrder.DESC)
.aggregation(HeatgridSortAggregation.AVG))))
.color(
new HeatgridColorConfig(
new HeatgridGradientCustomColor()
.mode(HeatgridGradientMode.GRADIENT)
.source(HeatgridCustomColorSource.CUSTOM)
.stops(
Arrays.asList(
new HeatgridColorStop()
.position(0L)
.color(
new HeatgridColor(
Arrays.asList(
"#FFFFFF", "#000000"))),
new HeatgridColorStop()
.position(100L)
.color(new HeatgridColor("#FF0000"))))))
.legend(new HeatgridLegend().showCaption(true))
.labelColumn(
new HeatgridLabelColumn()
.width(HeatgridLabelColumnWidth.M))))));

try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
102 changes: 102 additions & 0 deletions examples/v1/dashboards/CreateDashboard_2574782816.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
// Create a heatgrid widget with a preset gradient

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.HeatgridColorConfig;
import com.datadog.api.client.v1.model.HeatgridGradientMode;
import com.datadog.api.client.v1.model.HeatgridGradientPresetColor;
import com.datadog.api.client.v1.model.HeatgridLabelColumn;
import com.datadog.api.client.v1.model.HeatgridLabelColumnWidth;
import com.datadog.api.client.v1.model.HeatgridLegend;
import com.datadog.api.client.v1.model.HeatgridNestingDisplay;
import com.datadog.api.client.v1.model.HeatgridPresetColorSource;
import com.datadog.api.client.v1.model.HeatgridSort;
import com.datadog.api.client.v1.model.HeatgridSortAggregation;
import com.datadog.api.client.v1.model.HeatgridSortBy;
import com.datadog.api.client.v1.model.HeatgridSortByValue;
import com.datadog.api.client.v1.model.HeatgridSortByValueProperty;
import com.datadog.api.client.v1.model.HeatgridSortOrder;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinition;
import com.datadog.api.client.v1.model.HeatgridWidgetDefinitionType;
import com.datadog.api.client.v1.model.HeatgridWidgetFormula;
import com.datadog.api.client.v1.model.HeatgridWidgetRequest;
import com.datadog.api.client.v1.model.HeatgridWidgetResponseFormat;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
DashboardsApi apiInstance = new DashboardsApi(defaultClient);

Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.layoutType(DashboardLayoutType.ORDERED)
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new HeatgridWidgetDefinition()
.type(HeatgridWidgetDefinitionType.HEATGRID)
.requests(
Collections.singletonList(
new HeatgridWidgetRequest()
.responseFormat(
HeatgridWidgetResponseFormat.TIMESERIES)
.queries(
Collections.singletonList(
new FormulaAndFunctionQueryDefinition(
new FormulaAndFunctionMetricQueryDefinition()
.dataSource(
FormulaAndFunctionMetricDataSource
.METRICS)
.name("query1")
.query(
"avg:system.cpu.user{*} by"
+ " {host}"))))
.formulas(
Collections.singletonList(
new HeatgridWidgetFormula()
.formula("query1")))))
.sort(
new HeatgridSort()
.nestingDisplay(HeatgridNestingDisplay.FLAT)
.sortBy(
new HeatgridSortBy(
new HeatgridSortByValue()
.property(HeatgridSortByValueProperty.VALUE)
.order(HeatgridSortOrder.DESC)
.aggregation(HeatgridSortAggregation.AVG))))
.color(
new HeatgridColorConfig(
new HeatgridGradientPresetColor()
.mode(HeatgridGradientMode.GRADIENT)
.source(HeatgridPresetColorSource.PRESET)
.presetName("classic")))
.legend(new HeatgridLegend().showCaption(true))
.labelColumn(
new HeatgridLabelColumn()
.width(HeatgridLabelColumnWidth.M))))));

try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading