- 필수 기능
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- 디지털 경험
- 소프트웨어 제공
- 보안
- 로그 관리
- 관리
- 인프라스트럭처
- ci
- containers
- csm
- ndm
- otel_guides
- overview
- slos
- synthetics
- tests
- 워크플로
쿼리 값은 주어진 메트릭, APM 또는 로그 쿼리의 현재 값을 표시합니다. 해당 값이 예상 범위에 있는지 여부를 나타내기 위해 조건부 서식(예: 녹색/노란색/빨간색 배경)이 제공됩니다. 이는 시계열 데이터의 부수적인 배경으로 보완될 수 있습니다. 쿼리 값으로 표시되는 값은 즉각적인 측정이 필요하지 않습니다.
위젯은 보고된 최신 값 또는 해당 기간에 걸친 모든 쿼리 값에서 계산된 집계 결과를 표시할 수 있습니다. 이러한 시각화는 인프라스트럭처 쿼리를 보여주는, 협소하지만 명확한 창을 제공합니다.
avg, min, sum, max 또는 last 값으로 계산되는 단일 값으로 줄입니다.스크린보드에만 해당: 위젯에 커스텀 타임프레임이 있는지 또는 스크린보드의 글로벌 타임프레임이 있는지 선택하세요.
Show a Title 확인란을 활성화하여 위젯의 커스텀 타이틀을 표시하세요.
선택적으로 크기와 정렬을 정의할 수 있습니다.
이 위젯은 Dashboards API와 함께 사용할 수 있습니다. 더 많은 정보를 원하신다면 대시보드 API 가이드를 참조하세요.
쿼리 값 위젯의 전용 위젯 JSON 스키마 정의는 다음과 같습니다.
항목
유형
설명
autoscale
boolean
Whether to use auto-scaling or not.
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.
custom_unit
string
Display a unit of your choice on the widget.
precision
int64
Number of decimals to show. If not defined, the widget uses the raw value.
requests [required]
[object]
Widget definition.
aggregator
enum
Aggregator used for the request.
Allowed enum values: avg,last,max,min,sum,percentile
apm_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
audit_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
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.
event_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
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.
limit
object
Options for limiting results returned.
count
int64
Number of results to return.
order
enum
Direction of sort.
Allowed enum values: asc,desc
default: desc
style
object
Styling options for widget formulas.
palette
string
The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors
palette_index
int64
Index specifying which color to use within the palette.
log_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
network_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
process_query
object
The process query to use in the widget.
filter_by
[string]
List of processes.
limit
int64
Max number of items in the filter list.
metric [required]
string
Your chosen metric.
search_by
string
Your chosen search term.
profile_metrics_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
q
string
TODO.
queries
[ <oneOf>]
List of queries that can be returned directly or used in formulas.
Option 1
object
A formula and functions metrics query.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
data_source [required]
enum
Data source for metrics queries.
Allowed enum values: metrics
name [required]
string
Name of the query for use in formulas.
query [required]
string
Metrics query definition.
Option 2
object
A formula and functions events query.
compute [required]
object
Compute options.
aggregation [required]
enum
Aggregation methods for event platform queries.
Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
interval
int64
A time interval in milliseconds.
metric
string
Measurable attribute to compute.
data_source [required]
enum
Data source for event platform-based queries.
Allowed enum values: logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines
group_by
[object]
Group by options.
facet [required]
string
Event facet.
limit
int64
Number of groups to return.
sort
object
Options for sorting group by results.
aggregation [required]
enum
Aggregation methods for event platform queries.
Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg
metric
string
Metric used for sorting group by results.
order
enum
Direction of sort.
Allowed enum values: asc,desc
default: desc
indexes
[string]
An array of index names to query in the stream. Omit or use [] to query all indexes at once.
name [required]
string
Name of the query for use in formulas.
search
object
Search options.
query [required]
string
Events search string.
storage
string
Option for storage location. Feature in Private Beta.
Option 3
object
Process query using formulas and functions.
aggregator
enum
The aggregation methods available for metrics queries.
Allowed enum values: avg,min,max,sum,last,area,l2norm,percentile
data_source [required]
enum
Data sources that rely on the process backend.
Allowed enum values: process,container
is_normalized_cpu
boolean
Whether to normalize the CPU percentages.
limit
int64
Number of hits to return.
metric [required]
string
Process metric name.
name [required]
string
Name of query for use in formulas.
sort
enum
Direction of sort.
Allowed enum values: asc,desc
default: desc
tag_filters
[string]
An array of tags to filter by.
text_filter
string
Text to use as filter.
Option 4
object
A formula and functions APM dependency stats query.
data_source [required]
enum
Data source for APM dependency stats queries.
Allowed enum values: apm_dependency_stats
env [required]
string
APM environment.
is_upstream
boolean
Determines whether stats for upstream or downstream dependencies should be queried.
name [required]
string
Name of query to use in formulas.
operation_name [required]
string
Name of operation on service.
primary_tag_name
string
The name of the second primary tag used within APM; required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
primary_tag_value
string
Filter APM data by the second primary tag. primary_tag_name must also be specified.
resource_name [required]
string
APM resource.
service [required]
string
APM service.
stat [required]
enum
APM statistic.
Allowed enum values: avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count
Option 5
object
APM resource stats query using formulas and functions.
data_source [required]
enum
Data source for APM resource stats queries.
Allowed enum values: apm_resource_stats
env [required]
string
APM environment.
group_by
[string]
Array of fields to group results by.
name [required]
string
Name of this query to use in formulas.
operation_name
string
Name of operation on service.
primary_tag_name
string
Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
primary_tag_value
string
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
Option 6
object
A formula and functions metrics query.
additional_query_filters
string
Additional filters applied to the SLO query.
data_source [required]
enum
Data source for SLO measures queries.
Allowed enum values: slo
group_mode
enum
Group mode to query measures.
Allowed enum values: overall,components
measure [required]
enum
SLO measures queries.
Allowed enum values: good_events,bad_events,slo_status,error_budget_remaining,burn_rate,error_budget_burndown
name
string
Name of the query for use in formulas.
slo_id [required]
string
ID of an SLO to query measures.
slo_query_type
enum
Name of the query for use in formulas.
Allowed enum values: metric
Option 7
object
A formula and functions Cloud Cost query.
aggregator
enum
Aggregator used for the request.
Allowed enum values: avg,last,max,min,sum,percentile
data_source [required]
enum
Data source for Cloud Cost queries.
Allowed enum values: cloud_cost
name [required]
string
Name of the query for use in formulas.
query [required]
string
Query for Cloud Cost data.
response_format
enum
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
Allowed enum values: timeseries,scalar,event_list
rum_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
security_query
object
The log query.
compute
object
Define computation for a log query.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
group_by
[object]
List of tag prefixes to group by in the case of a cluster check.
facet [required]
string
Facet name.
limit
int64
Maximum number of items in the group.
sort
object
Define a sorting method.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
order [required]
enum
Widget sorting methods.
Allowed enum values: asc,desc
index
string
A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes
multi_compute
[object]
This field is mutually exclusive with compute.
aggregation [required]
string
The aggregation method.
facet
string
Facet name.
interval
int64
Define a time interval in seconds.
search
object
The query being made on the logs.
query [required]
string
Search value to apply.
text_align
enum
How to align the text on the widget.
Allowed enum values: center,left,right
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,week_to_date,month_to_date,1y,alert
timeseries_background
object
Set a timeseries on the widget background.
type [required]
enum
Timeseries is made using an area or bars.
Allowed enum values: bars,area
default: area
yaxis
object
Axis controls for the widget.
include_zero
boolean
Set to true to include zero.
label
string
The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
max
string
Specifies maximum numeric value to show on the axis. Defaults to auto.
default: auto
min
string
Specifies minimum numeric value to show on the axis. Defaults to auto.
default: auto
scale
string
Specifies the scale type. Possible values are linear, log, sqrt, and pow## (for example pow2 or pow0.5).
default: linear
title
string
Title of your widget.
title_align
enum
How to align the text on the widget.
Allowed enum values: center,left,right
title_size
string
Size of the title.
type [required]
enum
Type of the query value widget.
Allowed enum values: query_value
default: query_value
{
"autoscale": false,
"custom_links": [
{
"is_hidden": false,
"label": "Search logs for {{host}}",
"link": "https://app.datadoghq.com/logs?query={{host}}",
"override_label": "logs"
}
],
"custom_unit": "string",
"precision": "integer",
"requests": [
{
"aggregator": "string",
"apm_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"audit_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"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
}
],
"event_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"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
}
}
],
"log_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"network_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"process_query": {
"filter_by": [],
"limit": "integer",
"metric": "system.load.1",
"search_by": "string"
},
"profile_metrics_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"q": "string",
"queries": [],
"response_format": "timeseries",
"rum_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
},
"security_query": {
"compute": {
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
},
"group_by": [
{
"facet": "resource_name",
"limit": 50,
"sort": {
"aggregation": "avg",
"facet": "@string_query.interval",
"order": "desc"
}
}
],
"index": "days-3,days-7",
"multi_compute": [
{
"aggregation": "avg",
"facet": "@duration",
"interval": 5000
}
],
"search": {
"query": ""
}
}
}
],
"text_align": "string",
"time": {
"live_span": "5m"
},
"timeseries_background": {
"type": "bars",
"yaxis": {
"include_zero": false,
"label": "string",
"max": "string",
"min": "string",
"scale": "string"
}
},
"title": "string",
"title_align": "string",
"title_size": "string",
"type": "query_value"
}Additional helpful documentation, links, and articles:
| |
