Les widgets Graphique scindé ne sont pas pris en charge sur les screenboards et les dashboards publics.
Présentation
Un graphique scindé permet de décomposer une requête selon plusieurs valeurs de tag afin d’identifier les singularités et les patterns. Utilisez cette fonctionnalité pour analyser les performances des métriques selon diverses facettes, comparer les événements associés à divers tags ou créer des visualisations dynamiques.
Configuration
Créer un widget Graphique scindé
Accédez au widget Graphique scindé dans la barre des widgets, sous la section des groupes, puis faites-le glisser sur votre dashboard pour créer un graphique scindé vierge. Vous pourrez ainsi définir la requête et les dimensions à scinder. Pour en savoir plus sur les options de configuration, consultez la section Configuration.
Créer un graphique scindé à partir d’un widget existant
Vous pouvez également créer un graphique scindé en fractionnant un widget existant en fonction d’une valeur de tag depuis l’onglet Split Graph. Procédez comme suit pour ouvrir l’onglet Split Graph :
Ajoutez un nouveau widget à votre dashboard, puis cliquez sur l’onglet Split Graph situé en haut de l’éditeur de requête.
Ouvrez un widget en mode plein écran en sélectionnant l’icône de modification ou d’agrandissement depuis les options de contrôle du widget, puis cliquez sur l’onglet Split Graph.
Ouvrez le menu contextuel d’un widget sur votre dashboard, puis sélectionnez Split Graph.
Depuis l’onglet Split Graph, vous pouvez configurer le mode de fractionnement de votre graphique, définir la limite du nombre de graphiques affichés, et préciser leur ordre d’affichage.
Vous pouvez modifier la configuration du fractionnement en ajustant la dimension fractionnée, le nombre de graphiques affichés et les options d’affichage. Pour en savoir plus sur les options de configuration, consultez la section Configuration.
Cliquez sur Save to Dashboard pour créer un widget Graphique scindé en bas de votre dashboard. Aucune modification ne sera apportée au widget d’origine de votre dashboard.
Créer un graphique scindé depuis un autre endroit dans Datadog
Lorsqu’une visualisation présentant plusieurs valeurs est affichée dans l’application, vous pouvez l’exporter vers un dashboard en tant que widget.
Cliquez sur Export to Dashboard.
Dans la fenêtre d’exportation qui s’affiche, vous pouvez rechercher un dashboard existant vers lequel exporter le widget ou créer un dashboard contenant ce widget.
Configuration
Si vous créez un graphique scindé de toute pièce ou modifiez un graphique scindé existant sur votre dashboard, vous pouvez configurer le graphique ainsi que la façon dont il est fractionné.
L’éditeur de graphique scindé comporte deux sections distinctes : Edit Graph pour modifier le graphique et Split Graph pour modifier son fractionnement. Pour nommer le widget, modifiez le champ de texte situé en haut de l’éditeur.
Remarque : si vous créez un graphique scindé à partir d’un widget, vous pouvez uniquement configurer le fractionnement dans l’onglet Split Graph. Vous pouvez cliquer à tout moment sur l’onglet Edit pour modifier la requête.
Modifier le graphique
Configurez la requête de votre graphique avant de procéder au fractionnement. Choisissez un type de visualisation qui prend en charge le fractionnement et modifiez le mode d’affichage des graphiques. Vous pouvez également créer votre requête de toute pièce, comme vous le feriez dans l’éditeur de requête standard.
Pour en savoir plus sur la configuration de chacune de ces visualisations, consultez la documentation relative aux widgets pris en charge sur la page Widgets.
Les modifications que vous apportez apparaissent immédiatement dans les graphiques scindés, en bas de la fenêtre de l’éditeur.
Modifier le fractionnement
Vous pouvez modifier le mode de fractionnement du graphique via plusieurs options de configuration, ainsi que certains paramètres propres au fractionnement choisi.
Option de configuration
Description
One graph per
Ce menu déroulant définit la dimension utilisée pour le fractionnement de votre graphique d’origine.
Limit to
Cette option permet de spécifier le nombre de graphiques à afficher ainsi que les valeurs à sélectionner. Par défaut, le widget Graphique scindé sélectionne automatiquement les valeurs moyennes les plus élevées.
Sort by
Choisissez de trier vos graphiques en fonction d’une métrique ou d’un attribut/une facette. Pour choisir manuellement les tags à afficher, sélectionnez custom.
Show Controls
Cliquez sur cette option pour afficher une barre latérale contenant toutes les valeurs de tag disponibles. Sélectionnez des valeurs de tag manuellement pour passer d’un fractionnement dynamique à un fractionnement statique et afficher uniquement les valeurs que vous avez sélectionnées. Pour revenir au mode dynamique, effacez la sélection ou cliquez sur le bouton Custom, puis sélectionnez Top ou Bottom pour réactiver l’option de tri.
Graph Setting
Permet d’afficher les options propres aux graphiques scindésGraph Size : choisissez parmi quatre tailles différentes pour les graphiques individuels du widget Graphique scindé.Uniform Y-Axes : indiquez si les graphiques du widget doivent afficher le même axe des ordonnées ou si chaque axe peut être ajusté de façon autonome pour une lisibilité optimale.
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.
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
Query definition.
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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,incident_analytics
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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 of the query for use in formulas.
Allowed enum values: metric,time_slice
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
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.
show_present
boolean
Whether to show the present value.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
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
Option 2
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
enum
Type "live" denotes a live span in the new format.
Allowed enum values: live
unit [required]
enum
Unit of the time span.
Allowed enum values: minute,hour,day,week,month,year
value [required]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
int64
Start time in seconds since epoch.
to [required]
int64
End time in seconds since epoch.
type [required]
enum
Type "fixed" denotes a fixed span.
Allowed enum values: fixed
title
string
Title of the 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 change widget.
Allowed enum values: change
default: change
Option 2
object
This visualization displays a series of values by country on a world map.
custom_links
[object]
A 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.
requests [required]
[object]
Array of one request object to display in the widget. The request must contain a group-by tag whose value is a country ISO code.
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.
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
The widget metrics query.
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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,incident_analytics
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
Source from which to query items to display in the stream.
Allowed enum values: logs_stream,audit_stream,ci_pipeline_stream,ci_test_stream,rum_issue_stream,apm_issue_stream,trace_stream,logs_issue_stream,logs_pattern_stream,logs_transaction_stream,event_stream,rum_stream,llm_observability_stream
default: apm_issue_stream
event_size
enum
Size to use to display an event.
Allowed enum values: s,l
group_by
[object]
Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
Option for storage location. Feature in Private Beta.
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.
Set the sort type to group.
Allowed enum values: group
style [required]
object
The style to apply to the widget.
palette [required]
string
The color palette to apply to the widget.
palette_flip [required]
boolean
Whether to flip the palette tones.
time
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
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
Option 2
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
enum
Type "live" denotes a live span in the new format.
Allowed enum values: live
unit [required]
enum
Unit of the time span.
Allowed enum values: minute,hour,day,week,month,year
value [required]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
int64
Start time in seconds since epoch.
to [required]
int64
End time in seconds since epoch.
type [required]
enum
Type "fixed" denotes a fixed span.
Allowed enum values: fixed
title
string
The title of your widget.
title_align
enum
How to align the text on the widget.
Allowed enum values: center,left,right
title_size
string
The size of the title.
type [required]
enum
Type of the geomap widget.
Allowed enum values: geomap
default: geomap
view [required]
object
The view of the world that the map should render.
focus [required]
string
The 2-letter ISO code of a country to focus the map on. Or WORLD.
Option 3
object
Query values display the current value of a given metric, APM, or log query.
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.
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.
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.
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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,incident_analytics
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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 of the query for use in formulas.
Allowed enum values: metric,time_slice
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
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
<oneOf>
Time setting for the widget.
Option 1
object
Wrapper for live span
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
Option 2
object
Used for arbitrary live span times, such as 17 minutes or 6 hours.
type [required]
enum
Type "live" denotes a live span in the new format.
Allowed enum values: live
unit [required]
enum
Unit of the time span.
Allowed enum values: minute,hour,day,week,month,year
value [required]
int64
Value of the time span.
Option 3
object
Used for fixed span times, such as 'March 1 to March 7'.
from [required]
int64
Start time in seconds since epoch.
to [required]
int64
End time in seconds since epoch.
type [required]
enum
Type "fixed" denotes a fixed span.
Allowed enum values: fixed
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
Option 4
object
The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.
color_by_groups
[string]
List of groups used for colors.
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.
requests [required]
object
Widget definition.
table
object
Scatterplot request containing formulas and functions.
formulas
[object]
List of Scatterplot formulas that operate on queries.
alias
string
Expression alias.
dimension [required]
enum
Dimension of the Scatterplot.
Allowed enum values: x,y,radius,color
formula [required]
string
String expression built from queries, formulas, and functions.
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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,incident_analytics
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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.
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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 of the query for use in formulas.
Allowed enum values: metric,time_slice
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
cross_org_uuids
[string]
The source organization UUID for cross organization queries. Feature in Private Beta.
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
x
object
Updated scatter plot.
aggregator
enum
Aggregator used for the request.
Allowed enum values: avg,last,max,min,sum
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.