Skip to main content

active_tag_configurations

Creates, updates, deletes, gets or lists an active_tag_configurations resource.

Overview

Nameactive_tag_configurations
TypeResource
Iddatadog.metrics.active_tag_configurations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe metric name for this resource. (example: test.metric.latency)
attributesobjectObject containing the definition of a metric's actively queried tags and aggregations.
typestringThe metric actively queried configuration resource type. (default: actively_queried_configurations, example: actively_queried_configurations)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_active_metric_configurationsselectmetric_name, regionwindow[seconds]List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
metric_namestringThe name of the metric. (example: dist.http.endpoint.request)
regionstring(default: datadoghq.com)
window[seconds]integer (int64)The number of seconds of look back (from now). Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month). (example: 7200)

SELECT examples

List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name.

SELECT
id,
attributes,
type
FROM datadog.metrics.active_tag_configurations
WHERE metric_name = '{{ metric_name }}' -- required
AND region = '{{ region }}' -- required
AND window[seconds] = '{{ window[seconds] }}'
;