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

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:43.058121",
-            "spec_repo_commit": "642b7d0b"
+            "regenerated": "2025-04-08 20:00:44.120387",
+            "spec_repo_commit": "3e2afa30"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-08 14:37:43.074501",
-            "spec_repo_commit": "642b7d0b"
+            "regenerated": "2025-04-08 20:00:44.136063",
+            "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.rs

@@ -0,0 +1,32 @@
+// Create a retention filter with trace rate returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_apm_retention_filters::APMRetentionFiltersAPI;
+use datadog_api_client::datadogV2::model::ApmRetentionFilterType;
+use datadog_api_client::datadogV2::model::RetentionFilterCreateAttributes;
+use datadog_api_client::datadogV2::model::RetentionFilterCreateData;
+use datadog_api_client::datadogV2::model::RetentionFilterCreateRequest;
+use datadog_api_client::datadogV2::model::RetentionFilterType;
+use datadog_api_client::datadogV2::model::SpansFilterCreate;
+
+#[tokio::main]
+async fn main() {
+    let body = RetentionFilterCreateRequest::new(RetentionFilterCreateData::new(
+        RetentionFilterCreateAttributes::new(
+            true,
+            SpansFilterCreate::new("@http.status_code:200 service:my-service".to_string()),
+            RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
+            "my retention filter".to_string(),
+            1.0,
+        )
+        .trace_rate(1.0 as f64),
+        ApmRetentionFilterType::apm_retention_filter,
+    ));
+    let configuration = datadog::Configuration::new();
+    let api = APMRetentionFiltersAPI::with_config(configuration);
+    let resp = api.create_apm_retention_filter(body).await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

examples/v2_apm-retention-filters_UpdateApmRetentionFilter_3916044058.rs

@@ -0,0 +1,37 @@
+// Update a retention filter with trace rate returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_apm_retention_filters::APMRetentionFiltersAPI;
+use datadog_api_client::datadogV2::model::ApmRetentionFilterType;
+use datadog_api_client::datadogV2::model::RetentionFilterAllType;
+use datadog_api_client::datadogV2::model::RetentionFilterUpdateAttributes;
+use datadog_api_client::datadogV2::model::RetentionFilterUpdateData;
+use datadog_api_client::datadogV2::model::RetentionFilterUpdateRequest;
+use datadog_api_client::datadogV2::model::SpansFilterCreate;
+
+#[tokio::main]
+async fn main() {
+    // there is a valid "retention_filter" in the system
+    let retention_filter_data_id = std::env::var("RETENTION_FILTER_DATA_ID").unwrap();
+    let body = RetentionFilterUpdateRequest::new(RetentionFilterUpdateData::new(
+        RetentionFilterUpdateAttributes::new(
+            true,
+            SpansFilterCreate::new("@_top_level:1 test:service-demo".to_string()),
+            RetentionFilterAllType::SPANS_SAMPLING_PROCESSOR,
+            "test".to_string(),
+            0.9,
+        )
+        .trace_rate(1.0 as f64),
+        "test-id".to_string(),
+        ApmRetentionFilterType::apm_retention_filter,
+    ));
+    let configuration = datadog::Configuration::new();
+    let api = APMRetentionFiltersAPI::with_config(configuration);
+    let resp = api
+        .update_apm_retention_filter(retention_filter_data_id.clone(), body)
+        .await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV2/model/model_retention_filter_all_attributes.rs

@@ -45,6 +45,10 @@ pub struct RetentionFilterAllAttributes {
     /// a value of 1.0 keeps all spans matching the query.
     #[serde(rename = "rate")]
     pub rate: Option<f64>,
+    /// 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.
+    #[serde(rename = "trace_rate")]
+    pub trace_rate: Option<f64>,
     #[serde(flatten)]
     pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
     #[serde(skip)]
@@ -66,6 +70,7 @@ impl RetentionFilterAllAttributes {
             modified_by: None,
             name: None,
             rate: None,
+            trace_rate: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
@@ -126,6 +131,11 @@ impl RetentionFilterAllAttributes {
         self
     }
 
+    pub fn trace_rate(mut self, value: f64) -> Self {
+        self.trace_rate = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -169,6 +179,7 @@ impl<'de> Deserialize<'de> for RetentionFilterAllAttributes {
                 let mut modified_by: Option<String> = None;
                 let mut name: Option<String> = None;
                 let mut rate: Option<f64> = None;
+                let mut trace_rate: Option<f64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
                     serde_json::Value,
@@ -255,6 +266,12 @@ impl<'de> Deserialize<'de> for RetentionFilterAllAttributes {
                             }
                             rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "trace_rate" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            trace_rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         &_ => {
                             if let Ok(value) = serde_json::from_value(v.clone()) {
                                 additional_properties.insert(k, value);
@@ -275,6 +292,7 @@ impl<'de> Deserialize<'de> for RetentionFilterAllAttributes {
                     modified_by,
                     name,
                     rate,
+                    trace_rate,
                     additional_properties,
                     _unparsed,
                 };

src/datadogV2/model/model_retention_filter_attributes.rs

@@ -45,6 +45,10 @@ pub struct RetentionFilterAttributes {
     /// a value of 1.0 keeps all spans matching the query.
     #[serde(rename = "rate")]
     pub rate: Option<f64>,
+    /// 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.
+    #[serde(rename = "trace_rate")]
+    pub trace_rate: Option<f64>,
     #[serde(flatten)]
     pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
     #[serde(skip)]
@@ -66,6 +70,7 @@ impl RetentionFilterAttributes {
             modified_by: None,
             name: None,
             rate: None,
+            trace_rate: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
@@ -126,6 +131,11 @@ impl RetentionFilterAttributes {
         self
     }
 
+    pub fn trace_rate(mut self, value: f64) -> Self {
+        self.trace_rate = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -169,6 +179,7 @@ impl<'de> Deserialize<'de> for RetentionFilterAttributes {
                 let mut modified_by: Option<String> = None;
                 let mut name: Option<String> = None;
                 let mut rate: Option<f64> = None;
+                let mut trace_rate: Option<f64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
                     serde_json::Value,
@@ -255,6 +266,12 @@ impl<'de> Deserialize<'de> for RetentionFilterAttributes {
                             }
                             rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "trace_rate" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            trace_rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         &_ => {
                             if let Ok(value) = serde_json::from_value(v.clone()) {
                                 additional_properties.insert(k, value);
@@ -275,6 +292,7 @@ impl<'de> Deserialize<'de> for RetentionFilterAttributes {
                     modified_by,
                     name,
                     rate,
+                    trace_rate,
                     additional_properties,
                     _unparsed,
                 };

src/datadogV2/model/model_retention_filter_create_attributes.rs

@@ -27,6 +27,10 @@ pub struct RetentionFilterCreateAttributes {
     /// a value of 1.0 keeps all spans matching the query.
     #[serde(rename = "rate")]
     pub rate: f64,
+    /// 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.
+    #[serde(rename = "trace_rate")]
+    pub trace_rate: Option<f64>,
     #[serde(flatten)]
     pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
     #[serde(skip)]
@@ -48,11 +52,17 @@ impl RetentionFilterCreateAttributes {
             filter_type,
             name,
             rate,
+            trace_rate: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn trace_rate(mut self, value: f64) -> Self {
+        self.trace_rate = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -84,6 +94,7 @@ impl<'de> Deserialize<'de> for RetentionFilterCreateAttributes {
                 let mut filter_type: Option<crate::datadogV2::model::RetentionFilterType> = None;
                 let mut name: Option<String> = None;
                 let mut rate: Option<f64> = None;
+                let mut trace_rate: Option<f64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
                     serde_json::Value,
@@ -116,6 +127,12 @@ impl<'de> Deserialize<'de> for RetentionFilterCreateAttributes {
                         "rate" => {
                             rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "trace_rate" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            trace_rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         &_ => {
                             if let Ok(value) = serde_json::from_value(v.clone()) {
                                 additional_properties.insert(k, value);
@@ -136,6 +153,7 @@ impl<'de> Deserialize<'de> for RetentionFilterCreateAttributes {
                     filter_type,
                     name,
                     rate,
+                    trace_rate,
                     additional_properties,
                     _unparsed,
                 };

src/datadogV2/model/model_retention_filter_update_attributes.rs

@@ -27,6 +27,10 @@ pub struct RetentionFilterUpdateAttributes {
     /// a value of 1.0 keeps all spans matching the query.
     #[serde(rename = "rate")]
     pub rate: f64,
+    /// 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.
+    #[serde(rename = "trace_rate")]
+    pub trace_rate: Option<f64>,
     #[serde(flatten)]
     pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
     #[serde(skip)]
@@ -48,11 +52,17 @@ impl RetentionFilterUpdateAttributes {
             filter_type,
             name,
             rate,
+            trace_rate: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn trace_rate(mut self, value: f64) -> Self {
+        self.trace_rate = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -84,6 +94,7 @@ impl<'de> Deserialize<'de> for RetentionFilterUpdateAttributes {
                 let mut filter_type: Option<crate::datadogV2::model::RetentionFilterAllType> = None;
                 let mut name: Option<String> = None;
                 let mut rate: Option<f64> = None;
+                let mut trace_rate: Option<f64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
                     serde_json::Value,
@@ -116,6 +127,12 @@ impl<'de> Deserialize<'de> for RetentionFilterUpdateAttributes {
                         "rate" => {
                             rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "trace_rate" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            trace_rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         &_ => {
                             if let Ok(value) = serde_json::from_value(v.clone()) {
                                 additional_properties.insert(k, value);
@@ -136,6 +153,7 @@ impl<'de> Deserialize<'de> for RetentionFilterUpdateAttributes {
                     filter_type,
                     name,
                     rate,
+                    trace_rate,
                     additional_properties,
                     _unparsed,
                 };

tests/scenarios/cassettes/v2/apm_retention_filters/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/scenarios/cassettes/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.json

@@ -32,7 +32,7 @@
           "message": "Bad Request"
         }
       },
-      "recorded_at": "Wed, 10 Apr 2024 12:31:19 GMT"
+      "recorded_at": "Tue, 08 Apr 2025 11:32:44 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"