The treemap widget allows you to display proportions of one or datasets. This widget can display a single dataset with corresponding proportions, or multiple datasets with nested proportions.
Configuration
Select from the available data sources.
Configure the query, see the following resources for more information:
Metrics: See the querying documentation to configure a metric query.
Events: See the log search documentation to configure a log event query.
Context links are enabled by default, and can be toggled on or off. Context links bridge dashboard widgets with other pages (in Datadog, or third-party).
Display and interaction
Filter and focus
In the case where multiple groups of data are plotted at once, you can filter the widget to a single category and view proportions within it.
To filter and focus on a single category, hover over the outer portion of the category, and click. To go back to the previous view, click the back button on the top left header of the widget.
Accessing the context menu
To access the context menu, first hover over an individual category: this can be a nested category, or group - such as Canada, or Canada > Chrome in the following example. This reveals a vertical ellipsis button in the top right corner. When clicked, the context menu appears.
Full-screen
Viewing the treemap widget in full-screen reveals the standard set of full-screen options.
DEPRECATED: (deprecated) The attribute formerly used to determine color in the widget.
Allowed enum values: user
custom_links
[object]
List of custom links.
is_hidden
boolean
The flag for toggling context menu link visibility.
label
string
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link
string
The URL of the custom link. URL must include http or https. A relative URL must start with /.
override_label
string
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
group_by
enum
DEPRECATED: (deprecated) The attribute formerly used to group elements in the widget.
Allowed enum values: user,family,process
requests [required]
[object]
List of treemap widget requests.
formulas
[object]
List of formulas that operate on queries.
alias
string
Expression alias.
cell_display_mode
enum
Define a display mode for the table cell.
Allowed enum values: number,bar
conditional_formats
[object]
List of conditional formats.
comparator [required]
enum
Comparator to apply.
Allowed enum values: >,>=,<,<=
custom_bg_color
string
Color palette to apply to the background, same values available as palette.
custom_fg_color
string
Color palette to apply to the foreground, same values available as palette.
hide_value
boolean
True hides values.
image_url
string
Displays an image as the background.
metric
string
Metric from the request to correlate this conditional format with.
palette [required]
enum
Color palette to apply.
Allowed enum values: blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white,white_on_gray,white_on_green,green_on_white,white_on_red,white_on_yellow,yellow_on_white,black_on_light_yellow,black_on_light_green,black_on_light_red
timeframe
string
Defines the displayed timeframe.
value [required]
double
Value for the comparator.
formula [required]
string
String expression built from queries, formulas, and functions.
Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.
resource_name
string
APM resource name.
service [required]
string
APM service name.
stat [required]
enum
APM resource stat name.
Allowed enum values: errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99
response_format
enum
Timeseries or Scalar response.
Allowed enum values: timeseries,scalar
size_by
enum
DEPRECATED: (deprecated) The attribute formerly used to determine size in the widget.
Allowed enum values: pct_cpu,pct_mem
time
object
Time setting for the widget.
live_span
enum
The available timeframes depend on the widget you are using.
Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
title
string
Title of your widget.
type [required]
enum
Type of the treemap widget.
Allowed enum values: treemap
{"color_by":"user","custom_links":[{"is_hidden":false,"label":"Search logs for {{host}}","link":"https://app.datadoghq.com/logs?query={{host}}","override_label":"logs"}],"group_by":"user","requests":[{"formulas":[{"alias":"string","cell_display_mode":"number","conditional_formats":[{"comparator":">","custom_bg_color":"string","custom_fg_color":"string","hide_value":false,"image_url":"string","metric":"string","palette":"blue","timeframe":"string","value":0}],"formula":"func(a) + b","limit":{"count":"integer","order":"string"},"style":{"palette":"classic","palette_index":1}}],"q":"string","queries":[],"response_format":"timeseries"}],"size_by":"pct_cpu","time":{"live_span":"5m"},"title":"string","type":"treemap"}
Pie chart widget
Like the treemap widget, the pie chart widget can also be used to display nested proportions. The primary difference between the two is that the pie chart displays proportions in radial slices, and the treemap displays nested rectangles.
Further Reading
Additional helpful documentation, links, and articles: