Skip to content

Commit eba2825

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Mark aggregations arguments as deprecated since they're no longer needed (#2402)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 9d3a0f8 commit eba2825

File tree

6 files changed

+22
-99
lines changed

6 files changed

+22
-99
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:50.219008",
8-
"spec_repo_commit": "90c6252d"
7+
"regenerated": "2025-05-14 15:44:21.910071",
8+
"spec_repo_commit": "64f5e7ee"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-14 14:48:50.238620",
13-
"spec_repo_commit": "90c6252d"
12+
"regenerated": "2025-05-14 15:44:21.925869",
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'

lib/datadog_api_client/v2/api/metrics_api.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ def create_tag_configuration(metric_name, body, opts = {})
107107
# Create a tag configuration.
108108
#
109109
# Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
110-
# Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
111-
# on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
112-
# from an allow-list to a deny-list, and tags in the defined list will not be queryable.
113-
# Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
110+
# Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`
111+
# to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
112+
# not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`
113+
# permission.
114114
#
115115
# @param metric_name [String] The name of the metric.
116116
# @param body [MetricTagConfigurationCreateRequest]
@@ -324,7 +324,7 @@ def estimate_metrics_output_series(metric_name, opts = {})
324324
# @param opts [Hash] the optional parameters
325325
# @option opts [String] :filter_groups Filtered tag keys that the metric is configured to query with.
326326
# @option opts [Integer] :filter_hours_ago The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
327-
# @option opts [Integer] :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.
327+
# @option opts [Integer] :filter_num_aggregations Deprecated. Number of aggregations has no impact on volume.
328328
# @option opts [Boolean] :filter_pct A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
329329
# @option opts [Integer] :filter_timespan_h A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.
330330
# @return [Array<(MetricEstimateResponse, Integer, Hash)>] MetricEstimateResponse data, response status code and response headers

lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,7 @@ module DatadogAPIClient::V2
2121
class MetricTagConfigurationAttributes
2222
include BaseGenericModel
2323

24-
# A list of queryable aggregation combinations for a count, rate, or gauge metric.
25-
# By default, count and rate metrics require the (time: sum, space: sum) aggregation and
26-
# Gauge metrics require the (time: avg, space: avg) aggregation.
27-
# Additional time & space combinations are also available:
28-
#
29-
# - time: avg, space: avg
30-
# - time: avg, space: max
31-
# - time: avg, space: min
32-
# - time: avg, space: sum
33-
# - time: count, space: sum
34-
# - time: max, space: max
35-
# - time: min, space: min
36-
# - time: sum, space: avg
37-
# - time: sum, space: sum
38-
#
39-
# Can only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.
24+
# Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
4025
attr_accessor :aggregations
4126

4227
# Timestamp when the tag configuration was created.

lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,7 @@ module DatadogAPIClient::V2
2121
class MetricTagConfigurationCreateAttributes
2222
include BaseGenericModel
2323

24-
# A list of queryable aggregation combinations for a count, rate, or gauge metric.
25-
# By default, count and rate metrics require the (time: sum, space: sum) aggregation and
26-
# Gauge metrics require the (time: avg, space: avg) aggregation.
27-
# Additional time & space combinations are also available:
28-
#
29-
# - time: avg, space: avg
30-
# - time: avg, space: max
31-
# - time: avg, space: min
32-
# - time: avg, space: sum
33-
# - time: count, space: sum
34-
# - time: max, space: max
35-
# - time: min, space: min
36-
# - time: sum, space: avg
37-
# - time: sum, space: sum
38-
#
39-
# Can only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.
24+
# Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
4025
attr_accessor :aggregations
4126

4227
# When set to true, the configuration will exclude the configured tags and include any other submitted tags.

lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,7 @@ module DatadogAPIClient::V2
2121
class MetricTagConfigurationUpdateAttributes
2222
include BaseGenericModel
2323

24-
# A list of queryable aggregation combinations for a count, rate, or gauge metric.
25-
# By default, count and rate metrics require the (time: sum, space: sum) aggregation and
26-
# Gauge metrics require the (time: avg, space: avg) aggregation.
27-
# Additional time & space combinations are also available:
28-
#
29-
# - time: avg, space: avg
30-
# - time: avg, space: max
31-
# - time: avg, space: min
32-
# - time: avg, space: sum
33-
# - time: count, space: sum
34-
# - time: max, space: max
35-
# - time: min, space: min
36-
# - time: sum, space: avg
37-
# - time: sum, space: sum
38-
#
39-
# Can only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.
24+
# Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
4025
attr_accessor :aggregations
4126

4227
# When set to true, the configuration will exclude the configured tags and include any other submitted tags.

0 commit comments

Comments
 (0)