Add trace_rate support to APM retention filter APIs (#2494)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-08 14:37:44.703187",
-            "spec_repo_commit": "642b7d0b"
+            "regenerated": "2025-04-08 20:00:50.307792",
+            "spec_repo_commit": "3e2afa30"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-08 14:37:44.802514",
-            "spec_repo_commit": "642b7d0b"
+            "regenerated": "2025-04-08 20:00:50.398680",
+            "spec_repo_commit": "3e2afa30"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -25238,6 +25238,14 @@ components:
           example: 1.0
           format: double
           type: number
+        trace_rate:
+          description: 'Sample rate to apply to traces containing spans going through
+            this retention filter.
+
+            A value of 1.0 keeps all traces with spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
       type: object
     RetentionFilterAllType:
       default: spans-sampling-processor
@@ -25297,6 +25305,14 @@ components:
           example: 1.0
           format: double
           type: number
+        trace_rate:
+          description: 'Sample rate to apply to traces containing spans going through
+            this retention filter.
+
+            A value of 1.0 keeps all traces with spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
       type: object
     RetentionFilterCreateAttributes:
       description: The object describing the configuration of the retention filter
@@ -25322,6 +25338,14 @@ components:
           example: 1.0
           format: double
           type: number
+        trace_rate:
+          description: 'Sample rate to apply to traces containing spans going through
+            this retention filter.
+
+            A value of 1.0 keeps all traces with spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
       required:
       - name
       - filter
@@ -25393,6 +25417,14 @@ components:
           example: 1.0
           format: double
           type: number
+        trace_rate:
+          description: 'Sample rate to apply to traces containing spans going through
+            this retention filter.
+
+            A value of 1.0 keeps all traces with spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
       required:
       - name
       - filter

examples/v2/apm-retention-filters/CreateApmRetentionFilter_3853850379.py

@@ -0,0 +1,35 @@
+"""
+Create a retention filter with trace rate returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.apm_retention_filters_api import APMRetentionFiltersApi
+from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
+from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
+from datadog_api_client.v2.model.retention_filter_create_data import RetentionFilterCreateData
+from datadog_api_client.v2.model.retention_filter_create_request import RetentionFilterCreateRequest
+from datadog_api_client.v2.model.retention_filter_type import RetentionFilterType
+from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
+
+body = RetentionFilterCreateRequest(
+    data=RetentionFilterCreateData(
+        attributes=RetentionFilterCreateAttributes(
+            enabled=True,
+            filter=SpansFilterCreate(
+                query="@http.status_code:200 service:my-service",
+            ),
+            filter_type=RetentionFilterType.SPANS_SAMPLING_PROCESSOR,
+            name="my retention filter",
+            rate=1.0,
+            trace_rate=1.0,
+        ),
+        type=ApmRetentionFilterType.apm_retention_filter,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = APMRetentionFiltersApi(api_client)
+    response = api_instance.create_apm_retention_filter(body=body)
+
+    print(response)

examples/v2/apm-retention-filters/UpdateApmRetentionFilter_3916044058.py

@@ -0,0 +1,40 @@
+"""
+Update a retention filter with trace rate returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.apm_retention_filters_api import APMRetentionFiltersApi
+from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
+from datadog_api_client.v2.model.retention_filter_all_type import RetentionFilterAllType
+from datadog_api_client.v2.model.retention_filter_update_attributes import RetentionFilterUpdateAttributes
+from datadog_api_client.v2.model.retention_filter_update_data import RetentionFilterUpdateData
+from datadog_api_client.v2.model.retention_filter_update_request import RetentionFilterUpdateRequest
+from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
+
+# there is a valid "retention_filter" in the system
+RETENTION_FILTER_DATA_ID = environ["RETENTION_FILTER_DATA_ID"]
+
+body = RetentionFilterUpdateRequest(
+    data=RetentionFilterUpdateData(
+        attributes=RetentionFilterUpdateAttributes(
+            name="test",
+            rate=0.9,
+            trace_rate=1.0,
+            filter=SpansFilterCreate(
+                query="@_top_level:1 test:service-demo",
+            ),
+            enabled=True,
+            filter_type=RetentionFilterAllType.SPANS_SAMPLING_PROCESSOR,
+        ),
+        id="test-id",
+        type=ApmRetentionFilterType.apm_retention_filter,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = APMRetentionFiltersApi(api_client)
+    response = api_instance.update_apm_retention_filter(filter_id=RETENTION_FILTER_DATA_ID, body=body)
+
+    print(response)

src/datadog_api_client/v2/model/retention_filter_all_attributes.py

@@ -36,6 +36,7 @@ def openapi_types(_):
             "modified_by": (str,),
             "name": (str,),
             "rate": (float,),
+            "trace_rate": (float,),
         }
 
     attribute_map = {
@@ -50,6 +51,7 @@ def openapi_types(_):
         "modified_by": "modified_by",
         "name": "name",
         "rate": "rate",
+        "trace_rate": "trace_rate",
     }
 
     def __init__(
@@ -65,6 +67,7 @@ def __init__(
         modified_by: Union[str, UnsetType] = unset,
         name: Union[str, UnsetType] = unset,
         rate: Union[float, UnsetType] = unset,
+        trace_rate: Union[float, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -103,6 +106,10 @@ def __init__(
         :param rate: Sample rate to apply to spans going through this retention filter,
             a value of 1.0 keeps all spans matching the query.
         :type rate: float, optional
+
+        :param trace_rate: Sample rate to apply to traces containing spans going through this retention filter.
+            A value of 1.0 keeps all traces with spans matching the query.
+        :type trace_rate: float, optional
         """
         if created_at is not unset:
             kwargs["created_at"] = created_at
@@ -126,4 +133,6 @@ def __init__(
             kwargs["name"] = name
         if rate is not unset:
             kwargs["rate"] = rate
+        if trace_rate is not unset:
+            kwargs["trace_rate"] = trace_rate
         super().__init__(kwargs)

src/datadog_api_client/v2/model/retention_filter_attributes.py

@@ -36,6 +36,7 @@ def openapi_types(_):
             "modified_by": (str,),
             "name": (str,),
             "rate": (float,),
+            "trace_rate": (float,),
         }
 
     attribute_map = {
@@ -50,6 +51,7 @@ def openapi_types(_):
         "modified_by": "modified_by",
         "name": "name",
         "rate": "rate",
+        "trace_rate": "trace_rate",
     }
 
     def __init__(
@@ -65,6 +67,7 @@ def __init__(
         modified_by: Union[str, UnsetType] = unset,
         name: Union[str, UnsetType] = unset,
         rate: Union[float, UnsetType] = unset,
+        trace_rate: Union[float, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -103,6 +106,10 @@ def __init__(
         :param rate: Sample rate to apply to spans going through this retention filter,
             a value of 1.0 keeps all spans matching the query.
         :type rate: float, optional
+
+        :param trace_rate: Sample rate to apply to traces containing spans going through this retention filter.
+            A value of 1.0 keeps all traces with spans matching the query.
+        :type trace_rate: float, optional
         """
         if created_at is not unset:
             kwargs["created_at"] = created_at
@@ -126,4 +133,6 @@ def __init__(
             kwargs["name"] = name
         if rate is not unset:
             kwargs["rate"] = rate
+        if trace_rate is not unset:
+            kwargs["trace_rate"] = trace_rate
         super().__init__(kwargs)

src/datadog_api_client/v2/model/retention_filter_create_attributes.py

@@ -3,11 +3,13 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
@@ -28,6 +30,7 @@ def openapi_types(_):
             "filter_type": (RetentionFilterType,),
             "name": (str,),
             "rate": (float,),
+            "trace_rate": (float,),
         }
 
     attribute_map = {
@@ -36,6 +39,7 @@ def openapi_types(_):
         "filter_type": "filter_type",
         "name": "name",
         "rate": "rate",
+        "trace_rate": "trace_rate",
     }
 
     def __init__(
@@ -45,6 +49,7 @@ def __init__(
         filter_type: RetentionFilterType,
         name: str,
         rate: float,
+        trace_rate: Union[float, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -65,7 +70,13 @@ def __init__(
         :param rate: Sample rate to apply to spans going through this retention filter,
             a value of 1.0 keeps all spans matching the query.
         :type rate: float
+
+        :param trace_rate: Sample rate to apply to traces containing spans going through this retention filter.
+            A value of 1.0 keeps all traces with spans matching the query.
+        :type trace_rate: float, optional
         """
+        if trace_rate is not unset:
+            kwargs["trace_rate"] = trace_rate
         super().__init__(kwargs)
 
         self_.enabled = enabled

src/datadog_api_client/v2/model/retention_filter_update_attributes.py

@@ -3,11 +3,13 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
@@ -28,6 +30,7 @@ def openapi_types(_):
             "filter_type": (RetentionFilterAllType,),
             "name": (str,),
             "rate": (float,),
+            "trace_rate": (float,),
         }
 
     attribute_map = {
@@ -36,6 +39,7 @@ def openapi_types(_):
         "filter_type": "filter_type",
         "name": "name",
         "rate": "rate",
+        "trace_rate": "trace_rate",
     }
 
     def __init__(
@@ -45,6 +49,7 @@ def __init__(
         filter_type: RetentionFilterAllType,
         name: str,
         rate: float,
+        trace_rate: Union[float, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -65,7 +70,13 @@ def __init__(
         :param rate: Sample rate to apply to spans going through this retention filter,
             a value of 1.0 keeps all spans matching the query.
         :type rate: float
+
+        :param trace_rate: Sample rate to apply to traces containing spans going through this retention filter.
+            A value of 1.0 keeps all traces with spans matching the query.
+        :type trace_rate: float, optional
         """
+        if trace_rate is not unset:
+            kwargs["trace_rate"] = trace_rate
         super().__init__(kwargs)
 
         self_.enabled = enabled

tests/v2/cassettes/test_scenarios/test_create_a_default_retention_filter_returns_bad_request_response.frozen

@@ -1 +1 @@
-2024-04-10T12:31:19.300Z
+2025-04-08T11:32:44.101Z

tests/v2/cassettes/test_scenarios/test_create_a_retention_filter_returns_bad_request_response.frozen

@@ -1 +1 @@
-2023-09-21T16:39:02.926Z
+2025-04-08T11:32:44.623Z