active_tag_configurations

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

Overview

Name	active_tag_configurations
Type	Resource
Id	datadog.metrics.active_tag_configurations

Fields

The following fields are returned by SELECT queries:

list_active_metric_configurations

Name	Datatype	Description
id	string	The metric name for this resource. (example: test.metric.latency)
attributes	object	Object containing the definition of a metric's actively queried tags and aggregations.
type	string	The metric actively queried configuration resource type. (actively_queried_configurations) (default: actively_queried_configurations, example: actively_queried_configurations)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_active_metric_configurations	select	metric_name	window[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.

Name	Datatype	Description
metric_name	string	The name of the metric. (example: dist.http.endpoint.request)
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
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_active_metric_configurations

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 window[seconds] = '{{ window[seconds] }}'
;