Skip to content

Commit 89297af

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Mark aggregations arguments as deprecated since they're no longer needed (#2560)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 65c19f1 commit 89297af

File tree

7 files changed

+23
-115
lines changed

7 files changed

+23
-115
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-05-14 14:48:49.728472",
8-
"spec_repo_commit": "90c6252d"
7+
"regenerated": "2025-05-14 15:44:27.314895",
8+
"spec_repo_commit": "64f5e7ee"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-14 14:48:49.744180",
13-
"spec_repo_commit": "90c6252d"
12+
"regenerated": "2025-05-14 15:44:27.373827",
13+
"spec_repo_commit": "64f5e7ee"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -21171,38 +21171,8 @@ components:
2117121171
- space
2117221172
type: object
2117321173
MetricCustomAggregations:
21174-
description: 'A list of queryable aggregation combinations for a count, rate,
21175-
or gauge metric.
21176-
21177-
By default, count and rate metrics require the (time: sum, space: sum) aggregation
21178-
and
21179-
21180-
Gauge metrics require the (time: avg, space: avg) aggregation.
21181-
21182-
Additional time & space combinations are also available:
21183-
21184-
21185-
- time: avg, space: avg
21186-
21187-
- time: avg, space: max
21188-
21189-
- time: avg, space: min
21190-
21191-
- time: avg, space: sum
21192-
21193-
- time: count, space: sum
21194-
21195-
- time: max, space: max
21196-
21197-
- time: min, space: min
21198-
21199-
- time: sum, space: avg
21200-
21201-
- time: sum, space: sum
21202-
21203-
21204-
Can only be applied to non_distribution metrics that have a `metric_type`
21205-
of `count`, `rate`, or `gauge`.'
21174+
description: Deprecated. You no longer need to configure specific time and space
21175+
aggregations for Metrics Without Limits.
2120621176
example:
2120721177
- space: sum
2120821178
time: sum
@@ -50186,8 +50156,7 @@ paths:
5018650156
maximum: 2147483647
5018750157
minimum: 49
5018850158
type: integer
50189-
- description: The number of aggregations that a `count`, `rate`, or `gauge`
50190-
metric is configured to use. Max number of aggregation combos is 9.
50159+
- description: Deprecated. Number of aggregations has no impact on volume.
5019150160
example: 1
5019250161
in: query
5019350162
name: filter[num_aggregations]
@@ -50395,17 +50364,16 @@ paths:
5039550364
description: 'Create and define a list of queryable tag keys for an existing
5039650365
count/gauge/rate/distribution metric.
5039750366

50398-
Optionally, include percentile aggregations on any distribution metric or
50399-
configure custom aggregations
50367+
Optionally, include percentile aggregations on any distribution metric. By
50368+
setting `exclude_tags_mode`
5040050369

50401-
on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
50402-
the behavior is changed
50370+
to true, the behavior is changed from an allow-list to a deny-list, and tags
50371+
in the defined list are
5040350372

50404-
from an allow-list to a deny-list, and tags in the defined list will not be
50405-
queryable.
50373+
not queryable. Can only be used with application keys of users with the `Manage
50374+
Tags for Metrics`
5040650375

50407-
Can only be used with application keys of users with the `Manage Tags for
50408-
Metrics` permission.'
50376+
permission.'
5040950377
operationId: CreateTagConfiguration
5041050378
parameters:
5041150379
- $ref: '#/components/parameters/MetricName'

src/datadog_api_client/v2/api/metrics_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -526,10 +526,10 @@ def create_tag_configuration(
526526
"""Create a tag configuration.
527527
528528
Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
529-
Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
530-
on any count, rate, or gauge metric. By setting ``exclude_tags_mode`` to true the behavior is changed
531-
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
532-
Can only be used with application keys of users with the ``Manage Tags for Metrics`` permission.
529+
Optionally, include percentile aggregations on any distribution metric. By setting ``exclude_tags_mode``
530+
to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
531+
not queryable. Can only be used with application keys of users with the ``Manage Tags for Metrics``
532+
permission.
533533
534534
:param metric_name: The name of the metric.
535535
:type metric_name: str
@@ -600,7 +600,7 @@ def estimate_metrics_output_series(
600600
:type filter_groups: str, optional
601601
:param filter_hours_ago: The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
602602
:type filter_hours_ago: int, optional
603-
:param filter_num_aggregations: The number of aggregations that a ``count`` , ``rate`` , or ``gauge`` metric is configured to use. Max number of aggregation combos is 9.
603+
:param filter_num_aggregations: Deprecated. Number of aggregations has no impact on volume.
604604
:type filter_num_aggregations: int, optional
605605
:param filter_pct: A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
606606
:type filter_pct: bool, optional

src/datadog_api_client/v2/model/metric_custom_aggregations.py

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,7 @@
1212

1313
class MetricCustomAggregations(ModelSimple):
1414
"""
15-
A list of queryable aggregation combinations for a count, rate, or gauge metric.
16-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
17-
Gauge metrics require the (time: avg, space: avg) aggregation.
18-
Additional time & space combinations are also available:
19-
20-
* time: avg, space: avg
21-
* time: avg, space: max
22-
* time: avg, space: min
23-
* time: avg, space: sum
24-
* time: count, space: sum
25-
* time: max, space: max
26-
* time: min, space: min
27-
* time: sum, space: avg
28-
* time: sum, space: sum
29-
30-
Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``.
15+
Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
3116
3217
3318
:type value: [MetricCustomAggregation]

src/datadog_api_client/v2/model/metric_tag_configuration_attributes.py

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,7 @@ def __init__(
5959
"""
6060
Object containing the definition of a metric tag configuration attributes.
6161
62-
:param aggregations: A list of queryable aggregation combinations for a count, rate, or gauge metric.
63-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
64-
Gauge metrics require the (time: avg, space: avg) aggregation.
65-
Additional time & space combinations are also available:
66-
67-
* time: avg, space: avg
68-
* time: avg, space: max
69-
* time: avg, space: min
70-
* time: avg, space: sum
71-
* time: count, space: sum
72-
* time: max, space: max
73-
* time: min, space: min
74-
* time: sum, space: avg
75-
* time: sum, space: sum
76-
77-
Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``.
62+
:param aggregations: Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
7863
:type aggregations: MetricCustomAggregations, optional
7964
8065
:param created_at: Timestamp when the tag configuration was created.

src/datadog_api_client/v2/model/metric_tag_configuration_create_attributes.py

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -51,22 +51,7 @@ def __init__(
5151
"""
5252
Object containing the definition of a metric tag configuration to be created.
5353
54-
:param aggregations: A list of queryable aggregation combinations for a count, rate, or gauge metric.
55-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
56-
Gauge metrics require the (time: avg, space: avg) aggregation.
57-
Additional time & space combinations are also available:
58-
59-
* time: avg, space: avg
60-
* time: avg, space: max
61-
* time: avg, space: min
62-
* time: avg, space: sum
63-
* time: count, space: sum
64-
* time: max, space: max
65-
* time: min, space: min
66-
* time: sum, space: avg
67-
* time: sum, space: sum
68-
69-
Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``.
54+
:param aggregations: Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
7055
:type aggregations: MetricCustomAggregations, optional
7156
7257
:param exclude_tags_mode: When set to true, the configuration will exclude the configured tags and include any other submitted tags.

src/datadog_api_client/v2/model/metric_tag_configuration_update_attributes.py

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,7 @@ def __init__(
4747
"""
4848
Object containing the definition of a metric tag configuration to be updated.
4949
50-
:param aggregations: A list of queryable aggregation combinations for a count, rate, or gauge metric.
51-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
52-
Gauge metrics require the (time: avg, space: avg) aggregation.
53-
Additional time & space combinations are also available:
54-
55-
* time: avg, space: avg
56-
* time: avg, space: max
57-
* time: avg, space: min
58-
* time: avg, space: sum
59-
* time: count, space: sum
60-
* time: max, space: max
61-
* time: min, space: min
62-
* time: sum, space: avg
63-
* time: sum, space: sum
64-
65-
Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``.
50+
:param aggregations: Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
6651
:type aggregations: MetricCustomAggregations, optional
6752
6853
:param exclude_tags_mode: When set to true, the configuration will exclude the configured tags and include any other submitted tags.

0 commit comments

Comments
 (0)