tag_indexing_rule_exemptions

Creates, updates, deletes, gets or lists a tag_indexing_rule_exemptions resource.

Overview

Name	tag_indexing_rule_exemptions
Type	Resource
Id	datadog.metrics.tag_indexing_rule_exemptions

Fields

The following fields are returned by SELECT queries:

get_tag_indexing_rule_exemption

Name	Datatype	Description
id	string	The metric name, used as the resource ID. (example: dd.test.metric)
attributes	object	Attributes of a tag indexing rule exemption.
type	string	The tag indexing rule exemption resource type. (tag_indexing_rule_exemptions) (default: tag_indexing_rule_exemptions, example: tag_indexing_rule_exemptions)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tag_indexing_rule_exemption	select	metric_name		Returns why a metric is excluded from tag indexing rules.<br />Returns 200 with kind=exemption when an explicit exemption exists, 200 with<br />kind=legacy_tag_configuration when the metric has a legacy tag configuration acting as an<br />implicit exclusion, or 404 when neither applies.
create_tag_indexing_rule_exemption	insert	metric_name, data		Exempt a metric from all tag indexing rules. The response includes the created<br />exemption resource. Requires the Manage Tags for Metrics permission.
delete_tag_indexing_rule_exemption	delete	metric_name		Remove a metric's exemption from tag indexing rules. Idempotent: returns 204 whether or not<br />an exemption existed. Any associated legacy tag configuration record is also removed.<br />Requires the Manage Tags for Metrics permission.

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.

SELECT examples

get_tag_indexing_rule_exemption

Returns why a metric is excluded from tag indexing rules.<br />Returns 200 with kind=exemption when an explicit exemption exists, 200 with<br />kind=legacy_tag_configuration when the metric has a legacy tag configuration acting as an<br />implicit exclusion, or 404 when neither applies.

SELECT
id,
attributes,
type
FROM datadog.metrics.tag_indexing_rule_exemptions
WHERE metric_name = '{{ metric_name }}' -- required
;

INSERT examples

create_tag_indexing_rule_exemption

Exempt a metric from all tag indexing rules. The response includes the created<br />exemption resource. Requires the Manage Tags for Metrics permission.

INSERT INTO datadog.metrics.tag_indexing_rule_exemptions (
data,
metric_name
)
SELECT 
'{{ data }}' /* required */,
'{{ metric_name }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: tag_indexing_rule_exemptions
props:
  - name: metric_name
    value: "{{ metric_name }}"
    description: Required parameter for the tag_indexing_rule_exemptions resource.
  - name: data
    description: |
      Data object for creating a tag indexing rule exemption.
    value:
      attributes:
        reason: "{{ reason }}"
      type: "{{ type }}"

DELETE examples

delete_tag_indexing_rule_exemption

Remove a metric's exemption from tag indexing rules. Idempotent: returns 204 whether or not<br />an exemption existed. Any associated legacy tag configuration record is also removed.<br />Requires the Manage Tags for Metrics permission.

DELETE FROM datadog.metrics.tag_indexing_rule_exemptions
WHERE metric_name = '{{ metric_name }}' --required
;