Table: datadog_dashboard - Query Datadog Dashboards using SQL

Datadog Dashboards are an essential feature of the Datadog monitoring service, allowing users to visualize, analyze, and correlate data from different sources in one place. Dashboards can be customized to display data from various infrastructure components, applications, and services, providing a unified view of the system's performance and health. They are instrumental in identifying patterns, troubleshooting issues, and making data-driven decisions.

Table Usage Guide

The datadog_dashboard table provides insights into the configuration and state of Dashboards within a Datadog account. As a DevOps engineer, use this table to explore dashboard-specific details, including its layout, title, widgets, and associated metadata. Utilize it to manage and monitor your dashboards, ensuring optimal system performance and proactive issue resolution.

Examples

Basic info

Explore the characteristics of your Datadog dashboards, such as layout type and accessibility settings. This can help you understand the structure and restrictions of your dashboards, enhancing your data visualization management.

select
  id,
  author_handle,
  layout_type,
  url,
  is_read_only,
  created_at,
  jsonb_pretty(restricted_roles) as restricted_roles
from
  datadog_dashboard;

select
  id,
  author_handle,
  layout_type,
  url,
  is_read_only,
  created_at,
  restricted_roles
from
  datadog_dashboard;

List dashboards with restricted editing access

Discover the segments that have limited edit access on dashboards. This can be useful in managing user permissions and maintaining security protocols within your organization.

select
  dashboard.id,
  title as dashboard_title,
  dr.users as role_users
from
  datadog_dashboard as dashboard,
  jsonb_array_elements_text(restricted_roles) as role,
  datadog_role as dr
where
  dr.id = role;

select
  dashboard.id,
  title as dashboard_title,
  dr.users as role_users
from
  datadog_dashboard as dashboard,
  json_each(restricted_roles) as role,
  datadog_role as dr
where
  dr.id = role.value;

List read-only dashboards (only dashboard author and admins can make changes to it)

Identify instances where dashboards have been set to read-only, allowing only the author and admins to make changes. This can be useful for maintaining control over dashboard configurations and preventing unauthorized modifications.

select
  id,
  title,
  is_read_only
from
  datadog_dashboard
where
  is_read_only;

select
  id,
  title,
  is_read_only
from
  datadog_dashboard
where
  is_read_only;

Schema for datadog_dashboard

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
author_handle	text		Identifier of the dashboard author.
created_at	timestamp with time zone		Creation date of the dashboard.
description	text		Description of the dashboard.
id	text	=	Dashboard identifier.
is_read_only	boolean		Indicates if the dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type	text		Layout type of the dashboard. Can be on of "free" or "ordered".
modified_at	timestamp with time zone		Modification time of the dashboard.
reflow_type	text		Reflow type for a new dashboard layout dashboard. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.
restricted_roles	jsonb		A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. Overrides the `is_read_only` property if both are present.
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
template_variable_presets	jsonb		List of template variables saved views.
template_variables	jsonb		List of template variables for this dashboard.
title	text		Title of the dashboard.
url	text		URL of the dashboard.
widgets	jsonb		List of widgets to display on the dashboard.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- datadog

You can pass the configuration to the command with the --config argument:

steampipe_export_datadog --config '<your_config>' datadog_dashboard