Datadog Dashboard: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 36: Line 36:
===Elements===
===Elements===
====<tt>title</tt>====
====<tt>title</tt>====
Required. It is not mandated that the title is unique, there could be two dashboards with the same title, though it is not recommended.
Required. It is not necessary that the title is unique, there could be two dashboards with the same title, though it is not recommended.


====<tt>layout_type</tt>====
====<tt>layout_type</tt>====
Line 55: Line 55:
       "id": 5555555555555555,
       "id": 5555555555555555,
       "definition": {
       "definition": {
         "title": "statsd.myapp.status_cache.load with cluster_name:my-eks-01",
         "[[#Widget_Title|title]]": "statsd.myapp.status_cache.load with cluster_name:my-eks-01",
         "title_size": "16",
         "title_size": "16",
         "title_align": "left",
         "title_align": "left",
Line 75: Line 75:
     }
     }
</font>
</font>
====Elements====
=====<span id='Widget_Title'></span><tt>title</tt>=====
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===
===Request JSON Representation===
{{External|https://docs.datadoghq.com/dashboards/graphing_json/request_json/}}
{{External|https://docs.datadoghq.com/dashboards/graphing_json/request_json/}}
==Template Variable==
<font color=darkkhaki>
Understand template variables:
<syntaxhighlight lang='json'>
{
    "template_variables": [
        {
            "available_values": [],
            "default": "eks-01",
            "name": "cluster_name",
            "prefix": "cluster_name"
        }
    ],
    ...
}
</syntaxhighlight>
</font>

Latest revision as of 21:55, 16 April 2022

External

Internal

Overview

TO DO:

Export

Gear wheel → Export Dashboard JSON

Concepts

Dashboard JSON Representation

https://docs.datadoghq.com/dashboards/graphing_json/

{
  "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

https://docs.datadoghq.com/dashboards/graphing_json/widget_json/

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

https://docs.datadoghq.com/dashboards/graphing_json/request_json/

Template Variable

Understand template variables:

{
    "template_variables": [
        {
            "available_values": [],
            "default": "eks-01",
            "name": "cluster_name",
            "prefix": "cluster_name"
        }
    ],
    ...
}