Add sample_attribute to log exclusion filter (#1399)

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

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

.generator/schemas/v1/openapi.yaml

@@ -5931,6 +5931,12 @@ components:
             Scope down exclusion filter to only a subset of logs with a log query.
           example: "*"
           type: string
+        sample_attribute:
+          description: |-
+            Sample attribute to use for the sampling of logs going through this exclusion filter.
+            When set, only the logs with the specified attribute are sampled.
+          example: "@ci.job_id"
+          type: string
         sample_rate:
           description: |-
             Sample rate to apply to logs going through this exclusion filter,
@@ -29896,7 +29902,7 @@ paths:
         Update an index as identified by its name.
         Returns the Index object passed in the request body when the request is successful.
 
-        Using the `PUT` method updates your index’s configuration by **replacing**
+        Using the `PUT` method updates your index's configuration by **replacing**
         your current configuration with the new one sent to your Datadog organization.
       operationId: UpdateLogsIndex
       parameters:

examples/v1_logs-indexes_CreateLogsIndex.rs

@@ -20,8 +20,11 @@ async fn main() {
             .reset_utc_offset("+02:00".to_string()),
     )
     .daily_limit_warning_threshold_percentage(70.0 as f64)
-    .exclusion_filters(vec![LogsExclusion::new("payment".to_string())
-        .filter(LogsExclusionFilter::new(1.0).query("*".to_string()))])
+    .exclusion_filters(vec![LogsExclusion::new("payment".to_string()).filter(
+        LogsExclusionFilter::new(1.0)
+            .query("*".to_string())
+            .sample_attribute("@ci.job_id".to_string()),
+    )])
     .num_flex_logs_retention_days(360)
     .num_retention_days(15)
     .tags(vec![

examples/v1_logs-indexes_UpdateLogsIndex.rs

@@ -18,8 +18,11 @@ async fn main() {
         )
         .daily_limit_warning_threshold_percentage(70.0 as f64)
         .disable_daily_limit(false)
-        .exclusion_filters(vec![LogsExclusion::new("payment".to_string())
-            .filter(LogsExclusionFilter::new(1.0).query("*".to_string()))])
+        .exclusion_filters(vec![LogsExclusion::new("payment".to_string()).filter(
+            LogsExclusionFilter::new(1.0)
+                .query("*".to_string())
+                .sample_attribute("@ci.job_id".to_string()),
+        )])
         .num_flex_logs_retention_days(360)
         .num_retention_days(15)
         .tags(vec![

src/datadogV1/api/api_logs_indexes.rs

@@ -691,7 +691,7 @@ impl LogsIndexesAPI {
     /// Update an index as identified by its name.
     /// Returns the Index object passed in the request body when the request is successful.
     ///
-    /// Using the `PUT` method updates your index’s configuration by **replacing**
+    /// Using the `PUT` method updates your index's configuration by **replacing**
     /// your current configuration with the new one sent to your Datadog organization.
     pub async fn update_logs_index(
         &self,
@@ -715,7 +715,7 @@ impl LogsIndexesAPI {
     /// Update an index as identified by its name.
     /// Returns the Index object passed in the request body when the request is successful.
     ///
-    /// Using the `PUT` method updates your index’s configuration by **replacing**
+    /// Using the `PUT` method updates your index's configuration by **replacing**
     /// your current configuration with the new one sent to your Datadog organization.
     pub async fn update_logs_index_with_http_info(
         &self,

src/datadogV1/model/model_logs_exclusion_filter.rs

@@ -15,6 +15,10 @@ pub struct LogsExclusionFilter {
     /// Scope down exclusion filter to only a subset of logs with a log query.
     #[serde(rename = "query")]
     pub query: Option<String>,
+    /// Sample attribute to use for the sampling of logs going through this exclusion filter.
+    /// When set, only the logs with the specified attribute are sampled.
+    #[serde(rename = "sample_attribute")]
+    pub sample_attribute: Option<String>,
     /// Sample rate to apply to logs going through this exclusion filter,
     /// a value of 1.0 excludes all logs matching the query.
     #[serde(rename = "sample_rate")]
@@ -30,6 +34,7 @@ impl LogsExclusionFilter {
     pub fn new(sample_rate: f64) -> LogsExclusionFilter {
         LogsExclusionFilter {
             query: None,
+            sample_attribute: None,
             sample_rate,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -41,6 +46,11 @@ impl LogsExclusionFilter {
         self
     }
 
+    pub fn sample_attribute(mut self, value: String) -> Self {
+        self.sample_attribute = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -68,6 +78,7 @@ impl<'de> Deserialize<'de> for LogsExclusionFilter {
                 M: MapAccess<'a>,
             {
                 let mut query: Option<String> = None;
+                let mut sample_attribute: Option<String> = None;
                 let mut sample_rate: Option<f64> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -83,6 +94,13 @@ impl<'de> Deserialize<'de> for LogsExclusionFilter {
                             }
                             query = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "sample_attribute" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            sample_attribute =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "sample_rate" => {
                             sample_rate =
                                 Some(serde_json::from_value(v).map_err(M::Error::custom)?);
@@ -99,6 +117,7 @@ impl<'de> Deserialize<'de> for LogsExclusionFilter {
 
                 let content = LogsExclusionFilter {
                     query,
+                    sample_attribute,
                     sample_rate,
                     additional_properties,
                     _unparsed,

tests/scenarios/features/v1/logs_indexes.feature

@@ -11,21 +11,21 @@ Feature: Logs Indexes
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
   Scenario: Create an index returns "Invalid Parameter Error" response
     Given new "CreateLogsIndex" request
-    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_attribute": "@ci.job_id", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
     When the request is sent
     Then the response status is 400 Invalid Parameter Error
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
   Scenario: Create an index returns "OK" response
     Given new "CreateLogsIndex" request
-    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_attribute": "@ci.job_id", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
     When the request is sent
     Then the response status is 200 OK
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
   Scenario: Create an index returns "Unprocessable Entity" response
     Given new "CreateLogsIndex" request
-    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "exclusion_filters": [{"filter": {"query": "*", "sample_attribute": "@ci.job_id", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "name": "main", "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
     When the request is sent
     Then the response status is 422 Unprocessable Entity
 
@@ -73,15 +73,15 @@ Feature: Logs Indexes
   Scenario: Update an index returns "Invalid Parameter Error" response
     Given new "UpdateLogsIndex" request
     And request contains "name" parameter from "REPLACE.ME"
-    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_attribute": "@ci.job_id", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
     When the request is sent
     Then the response status is 400 Invalid Parameter Error
 
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
   Scenario: Update an index returns "OK" response
     Given new "UpdateLogsIndex" request
     And request contains "name" parameter from "REPLACE.ME"
-    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
+    And body with value {"daily_limit": 300000000, "daily_limit_reset": {"reset_time": "14:00", "reset_utc_offset": "+02:00"}, "daily_limit_warning_threshold_percentage": 70, "disable_daily_limit": false, "exclusion_filters": [{"filter": {"query": "*", "sample_attribute": "@ci.job_id", "sample_rate": 1.0}, "name": "payment"}], "filter": {"query": "source:python"}, "num_flex_logs_retention_days": 360, "num_retention_days": 15, "tags": ["team:backend", "env:production"]}
     When the request is sent
     Then the response status is 200 OK