diff --git a/.apigentools-info b/.apigentools-info index 5d2b62bc97..f5418c847d 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-05-07 17:07:24.917132", - "spec_repo_commit": "a1235a0d" + "regenerated": "2025-05-07 20:12:31.206396", + "spec_repo_commit": "49255f5b" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-05-07 17:07:24.932247", - "spec_repo_commit": "a1235a0d" + "regenerated": "2025-05-07 20:12:31.221741", + "spec_repo_commit": "49255f5b" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index af9c9a9822..c524bd945a 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -20918,6 +20918,7 @@ components: - ZSTD1 - GZIP MetricCustomAggregation: + deprecated: true description: A time and space aggregation combination for use in query. example: space: sum @@ -20932,6 +20933,7 @@ components: - space type: object MetricCustomAggregations: + deprecated: true description: 'A list of queryable aggregation combinations for a count, rate, or gauge metric. @@ -20964,13 +20966,9 @@ components: Can only be applied to non_distribution metrics that have a `metric_type` of `count`, `rate`, or `gauge`.' - example: - - space: sum - time: sum - - space: sum - time: count items: $ref: '#/components/schemas/MetricCustomAggregation' + deprecated: true type: array MetricCustomSpaceAggregation: description: A space aggregation for use in query. @@ -21436,6 +21434,7 @@ components: time: count items: $ref: '#/components/schemas/MetricCustomAggregation' + deprecated: true type: array MetricSuggestedTagsAndAggregations: description: Object for a single metric's actively queried tags and aggregations. @@ -21461,6 +21460,7 @@ components: properties: active_aggregations: $ref: '#/components/schemas/MetricSuggestedAggregations' + deprecated: true active_tags: description: List of tag keys that have been actively queried. example: @@ -21500,6 +21500,7 @@ components: properties: aggregations: $ref: '#/components/schemas/MetricCustomAggregations' + deprecated: true created_at: description: Timestamp when the tag configuration was created. example: '2020-03-25T09:48:37.463835Z' @@ -21544,6 +21545,7 @@ components: properties: aggregations: $ref: '#/components/schemas/MetricCustomAggregations' + deprecated: true exclude_tags_mode: description: 'When set to true, the configuration will exclude the configured tags and include any other submitted tags. @@ -21655,6 +21657,7 @@ components: properties: aggregations: $ref: '#/components/schemas/MetricCustomAggregations' + deprecated: true exclude_tags_mode: description: 'When set to true, the configuration will exclude the configured tags and include any other submitted tags. @@ -50068,9 +50071,8 @@ paths: - Metrics /api/v2/metrics/{metric_name}/estimate: get: - description: Returns the estimated cardinality for a metric with a given tag, - percentile and number of aggregations configuration using Metrics without - Limits™. + description: Returns the estimated cardinality for a metric with a given tag + and percentile configuration using Metrics without Limits™. operationId: EstimateMetricsOutputSeries parameters: - $ref: '#/components/parameters/MetricName' @@ -50092,8 +50094,9 @@ paths: maximum: 2147483647 minimum: 49 type: integer - - description: The number of aggregations that a `count`, `rate`, or `gauge` - metric is configured to use. Max number of aggregation combos is 9. + - deprecated: true + description: This argument has no effect as all time and space combinations + are now available with no impact on customer bills. example: 1 in: query name: filter[num_aggregations] @@ -61234,15 +61237,31 @@ tags: description: Find out more at url: https://docs.datadoghq.com/logs/logs_to_metrics/ name: Logs Metrics -- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can - be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period - (timeseries and scalar)\n- Modify tag configurations for metrics\n- View tags - and volumes for metrics\n\n**Note**: A graph can only contain a set number of - points\nand as the timeframe over which a metric is viewed increases,\naggregation - between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete - `manage_tags` API methods can only be performed by\na user who has the `Manage - Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/) - for more information." +- description: 'The metrics endpoint allows you to: + + + - Post metrics data so it can be graphed on Datadog dashboards + + - Query metrics from any time period (timeseries and scalar) + + - Modify tag configurations for metrics + + - View tags and volumes for metrics + + + **Note**: A graph can only contain a set number of points + + and as the timeframe over which a metric is viewed increases, + + aggregation between points occurs to stay below that set number. + + + The Post, Patch, and Delete `manage_tags` API methods can only be performed by + + a user who has the `Manage Tags for Metrics` permission. + + + See the [Metrics page](https://docs.datadoghq.com/metrics/) for more information.' name: Metrics - description: 'Configure your [Datadog Microsoft Teams integration](https://docs.datadoghq.com/integrations/microsoft_teams/) diff --git a/examples/v2/metrics/EstimateMetricsOutputSeries.py b/examples/v2/metrics/EstimateMetricsOutputSeries.py index 165dd1309d..3c29a2203b 100644 --- a/examples/v2/metrics/EstimateMetricsOutputSeries.py +++ b/examples/v2/metrics/EstimateMetricsOutputSeries.py @@ -11,7 +11,6 @@ response = api_instance.estimate_metrics_output_series( metric_name="system.cpu.idle", filter_groups="app,host", - filter_num_aggregations=4, ) print(response) diff --git a/src/datadog_api_client/v2/api/metrics_api.py b/src/datadog_api_client/v2/api/metrics_api.py index 35a00b39d7..1eb511ca47 100644 --- a/src/datadog_api_client/v2/api/metrics_api.py +++ b/src/datadog_api_client/v2/api/metrics_api.py @@ -47,7 +47,7 @@ class MetricsApi: """ The metrics endpoint allows you to: - * Post metrics data so it can be graphed on Datadog’s dashboards + * Post metrics data so it can be graphed on Datadog dashboards * Query metrics from any time period (timeseries and scalar) * Modify tag configurations for metrics * View tags and volumes for metrics @@ -592,7 +592,7 @@ def estimate_metrics_output_series( ) -> MetricEstimateResponse: """Tag Configuration Cardinality Estimator. - Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™. + Returns the estimated cardinality for a metric with a given tag and percentile configuration using Metrics without Limits™. :param metric_name: The name of the metric. :type metric_name: str @@ -600,7 +600,7 @@ def estimate_metrics_output_series( :type filter_groups: str, optional :param filter_hours_ago: The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours. :type filter_hours_ago: int, optional - :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. + :param filter_num_aggregations: This argument has no effect as all time and space combinations are now available with no impact on customer bills. :type filter_num_aggregations: int, optional :param filter_pct: A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators. :type filter_pct: bool, optional diff --git a/src/datadog_api_client/v2/model/metric_tag_configuration_attributes.py b/src/datadog_api_client/v2/model/metric_tag_configuration_attributes.py index 1ed0d8b74b..2e3968cd3a 100644 --- a/src/datadog_api_client/v2/model/metric_tag_configuration_attributes.py +++ b/src/datadog_api_client/v2/model/metric_tag_configuration_attributes.py @@ -74,7 +74,7 @@ def __init__( * time: sum, space: avg * time: sum, space: sum - Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. + Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. **Deprecated**. :type aggregations: MetricCustomAggregations, optional :param created_at: Timestamp when the tag configuration was created. diff --git a/src/datadog_api_client/v2/model/metric_tag_configuration_create_attributes.py b/src/datadog_api_client/v2/model/metric_tag_configuration_create_attributes.py index a9a6c9e273..4694e1c078 100644 --- a/src/datadog_api_client/v2/model/metric_tag_configuration_create_attributes.py +++ b/src/datadog_api_client/v2/model/metric_tag_configuration_create_attributes.py @@ -66,7 +66,7 @@ def __init__( * time: sum, space: avg * time: sum, space: sum - Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. + Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. **Deprecated**. :type aggregations: MetricCustomAggregations, optional :param exclude_tags_mode: When set to true, the configuration will exclude the configured tags and include any other submitted tags. diff --git a/src/datadog_api_client/v2/model/metric_tag_configuration_update_attributes.py b/src/datadog_api_client/v2/model/metric_tag_configuration_update_attributes.py index 6d7da1523d..865506ba53 100644 --- a/src/datadog_api_client/v2/model/metric_tag_configuration_update_attributes.py +++ b/src/datadog_api_client/v2/model/metric_tag_configuration_update_attributes.py @@ -62,7 +62,7 @@ def __init__( * time: sum, space: avg * time: sum, space: sum - Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. + Can only be applied to non_distribution metrics that have a ``metric_type`` of ``count`` , ``rate`` , or ``gauge``. **Deprecated**. :type aggregations: MetricCustomAggregations, optional :param exclude_tags_mode: When set to true, the configuration will exclude the configured tags and include any other submitted tags. diff --git a/tests/v2/features/metrics.feature b/tests/v2/features/metrics.feature index e412ab0136..c9f57d03f5 100644 --- a/tests/v2/features/metrics.feature +++ b/tests/v2/features/metrics.feature @@ -1,7 +1,7 @@ @endpoint(metrics) @endpoint(metrics-v2) Feature: Metrics The metrics endpoint allows you to: - Post metrics data so it can be - graphed on Datadog’s dashboards - Query metrics from any time period + graphed on Datadog dashboards - Query metrics from any time period (timeseries and scalar) - Modify tag configurations for metrics - View tags and volumes for metrics **Note**: A graph can only contain a set number of points and as the timeframe over which a metric is viewed @@ -370,7 +370,6 @@ Feature: Metrics Given new "EstimateMetricsOutputSeries" request And request contains "metric_name" parameter with value "system.cpu.idle" And request contains "filter[groups]" parameter with value "app,host" - And request contains "filter[num_aggregations]" parameter with value 4 When the request is sent Then the response status is 200 Success