Add sample_attribute to log exclusion filter (#3861)

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:

api/datadogV1/api_logs_indexes.go

@@ -437,7 +437,7 @@ func (a *LogsIndexesApi) ListLogIndexes(ctx _context.Context) (LogsIndexListResp
 // 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.
 func (a *LogsIndexesApi) UpdateLogsIndex(ctx _context.Context, name string, body LogsIndexUpdateRequest) (LogsIndex, *_nethttp.Response, error) {
 	var (

api/datadogV1/model_logs_exclusion_filter.go

@@ -15,6 +15,9 @@ type LogsExclusionFilter struct {
 	// Default query is `*`, meaning all logs flowing in the index would be excluded.
 	// Scope down exclusion filter to only a subset of logs with a log query.
 	Query *string `json:"query,omitempty"`
+	// 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.
+	SampleAttribute *string `json:"sample_attribute,omitempty"`
 	// Sample rate to apply to logs going through this exclusion filter,
 	// a value of 1.0 excludes all logs matching the query.
 	SampleRate float64 `json:"sample_rate"`
@@ -69,6 +72,34 @@ func (o *LogsExclusionFilter) SetQuery(v string) {
 	o.Query = &v
 }
 
+// GetSampleAttribute returns the SampleAttribute field value if set, zero value otherwise.
+func (o *LogsExclusionFilter) GetSampleAttribute() string {
+	if o == nil || o.SampleAttribute == nil {
+		var ret string
+		return ret
+	}
+	return *o.SampleAttribute
+}
+
+// GetSampleAttributeOk returns a tuple with the SampleAttribute field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *LogsExclusionFilter) GetSampleAttributeOk() (*string, bool) {
+	if o == nil || o.SampleAttribute == nil {
+		return nil, false
+	}
+	return o.SampleAttribute, true
+}
+
+// HasSampleAttribute returns a boolean if a field has been set.
+func (o *LogsExclusionFilter) HasSampleAttribute() bool {
+	return o != nil && o.SampleAttribute != nil
+}
+
+// SetSampleAttribute gets a reference to the given string and assigns it to the SampleAttribute field.
+func (o *LogsExclusionFilter) SetSampleAttribute(v string) {
+	o.SampleAttribute = &v
+}
+
 // GetSampleRate returns the SampleRate field value.
 func (o *LogsExclusionFilter) GetSampleRate() float64 {
 	if o == nil {
@@ -101,6 +132,9 @@ func (o LogsExclusionFilter) MarshalJSON() ([]byte, error) {
 	if o.Query != nil {
 		toSerialize["query"] = o.Query
 	}
+	if o.SampleAttribute != nil {
+		toSerialize["sample_attribute"] = o.SampleAttribute
+	}
 	toSerialize["sample_rate"] = o.SampleRate
 
 	for key, value := range o.AdditionalProperties {
@@ -112,8 +146,9 @@ func (o LogsExclusionFilter) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *LogsExclusionFilter) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Query      *string  `json:"query,omitempty"`
-		SampleRate *float64 `json:"sample_rate"`
+		Query           *string  `json:"query,omitempty"`
+		SampleAttribute *string  `json:"sample_attribute,omitempty"`
+		SampleRate      *float64 `json:"sample_rate"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
@@ -123,11 +158,12 @@ func (o *LogsExclusionFilter) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"query", "sample_rate"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"query", "sample_attribute", "sample_rate"})
 	} else {
 		return err
 	}
 	o.Query = all.Query
+	o.SampleAttribute = all.SampleAttribute
 	o.SampleRate = *all.SampleRate
 
 	if len(additionalProperties) > 0 {

examples/v1/logs-indexes/CreateLogsIndex.go

@@ -23,8 +23,9 @@ func main() {
 		ExclusionFilters: []datadogV1.LogsExclusion{
 			{
 				Filter: &datadogV1.LogsExclusionFilter{
-					Query:      datadog.PtrString("*"),
-					SampleRate: 1.0,
+					Query:           datadog.PtrString("*"),
+					SampleAttribute: datadog.PtrString("@ci.job_id"),
+					SampleRate:      1.0,
 				},
 				Name: "payment",
 			},

examples/v1/logs-indexes/UpdateLogsIndex.go

@@ -24,8 +24,9 @@ func main() {
 		ExclusionFilters: []datadogV1.LogsExclusion{
 			{
 				Filter: &datadogV1.LogsExclusionFilter{
-					Query:      datadog.PtrString("*"),
-					SampleRate: 1.0,
+					Query:           datadog.PtrString("*"),
+					SampleAttribute: datadog.PtrString("@ci.job_id"),
+					SampleRate:      1.0,
 				},
 				Name: "payment",
 			},

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