Datadog Dashboard
Jump to navigation
Jump to search
External
Internal
Overview
TO DO:
- https://docs.datadoghq.com/getting_started/dashboards/
- https://docs.datadoghq.com/tracing/guide/apm_dashboard/
- How a JSON representation of the dashboard can be produced via the API (not export from the console)?
Export
Gear wheel → Export Dashboard JSON
Concepts
Dashboard JSON Representation
{
"title":
"description":
"is_read_only": true,
"layout_type": "ordered",
"reflow_type": "fixed",
"id": 444444444444444,
"widgets": [
{ widget-JSON },
...
]
}
Elements
title
Required. It is not necessary that the title is unique, there could be two dashboards with the same title, though it is not recommended.
layout_type
Required. Possible values: "ordered".
widgets
Required.
id
Should I get rid of "id", isn't that unique and will be generated?
Widget
Widget JSON Representation
{
"id": 5555555555555555,
"definition": {
"title": "statsd.myapp.status_cache.load with cluster_name:my-eks-01",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "timeseries",
"requests": [
{
"q": "statsd.myapp.status_cache.load{env:prod,cluster_name:my-eks-01}.as_count()",
"display_type": "bars"
}
]
},
"layout": {
"x": 4,
"y": 0,
"width": 4,
"height": 2
}
}
Elements
title
Required. It is not necessary that the title is unique, there could be two widgets with the same title, though it is not recommended.
Request JSON Representation
Template Variable
Understand template variables:
{
"template_variables": [
{
"available_values": [],
"default": "eks-01",
"name": "cluster_name",
"prefix": "cluster_name"
}
],
...
}