Add support for Array Processor in Logs Pipelines (#2658)

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-07-02 20:43:17.503949",
-            "spec_repo_commit": "e327e6df"
+            "regenerated": "2025-07-03 15:49:21.236636",
+            "spec_repo_commit": "d781944f"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-02 20:43:17.520727",
-            "spec_repo_commit": "e327e6df"
+            "regenerated": "2025-07-03 15:49:21.253240",
+            "spec_repo_commit": "d781944f"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -5163,6 +5163,143 @@ components:
       type: string
       x-enum-varnames:
       - ARITHMETIC_PROCESSOR
+    LogsArrayProcessor:
+      description: 'A processor for extracting, aggregating, or transforming values
+        from JSON arrays within your logs.
+
+        Supported operations are:
+
+        - Select value from matching element
+
+        - Compute array length
+
+        - Append a value to an array'
+      properties:
+        is_enabled:
+          default: false
+          description: Whether or not the processor is enabled.
+          type: boolean
+        name:
+          description: Name of the processor.
+          type: string
+        operation:
+          $ref: '#/components/schemas/LogsArrayProcessorOperation'
+        type:
+          $ref: '#/components/schemas/LogsArrayProcessorType'
+      required:
+      - operation
+      - type
+      type: object
+    LogsArrayProcessorOperation:
+      description: Configuration of the array processor operation to perform.
+      oneOf:
+      - $ref: '#/components/schemas/LogsArrayProcessorOperationAppend'
+      - $ref: '#/components/schemas/LogsArrayProcessorOperationLength'
+      - $ref: '#/components/schemas/LogsArrayProcessorOperationSelect'
+    LogsArrayProcessorOperationAppend:
+      description: Operation that appends a value to a target array attribute.
+      properties:
+        preserve_source:
+          default: true
+          description: Remove or preserve the remapped source element.
+          type: boolean
+        source:
+          description: Attribute path containing the value to append.
+          example: network.client.ip
+          type: string
+        target:
+          description: Attribute path of the array to append to.
+          example: sourceIps
+          type: string
+        type:
+          $ref: '#/components/schemas/LogsArrayProcessorOperationAppendType'
+      required:
+      - type
+      - source
+      - target
+      type: object
+    LogsArrayProcessorOperationAppendType:
+      description: Operation type.
+      enum:
+      - append
+      example: append
+      type: string
+      x-enum-varnames:
+      - APPEND
+    LogsArrayProcessorOperationLength:
+      description: Operation that computes the length of a `source` array and stores
+        the result in the `target` attribute.
+      properties:
+        source:
+          description: Attribute path of the array to measure.
+          example: tags
+          type: string
+        target:
+          description: Attribute that receives the computed length.
+          example: tagCount
+          type: string
+        type:
+          $ref: '#/components/schemas/LogsArrayProcessorOperationLengthType'
+      required:
+      - type
+      - source
+      - target
+      type: object
+    LogsArrayProcessorOperationLengthType:
+      description: Operation type.
+      enum:
+      - length
+      example: length
+      type: string
+      x-enum-varnames:
+      - LENGTH
+    LogsArrayProcessorOperationSelect:
+      description: Operation that finds an object in a `source` array using a `filter`,
+        and then extracts a specific value into the `target` attribute.
+      properties:
+        filter:
+          description: Filter condition expressed as `key:value` used to find the
+            matching element.
+          example: name:Referrer
+          type: string
+        source:
+          description: Attribute path of the array to search into.
+          example: httpRequest.headers
+          type: string
+        target:
+          description: Attribute that receives the extracted value.
+          example: referrer
+          type: string
+        type:
+          $ref: '#/components/schemas/LogsArrayProcessorOperationSelectType'
+        value_to_extract:
+          description: Key of the value to extract from the matching element.
+          example: value
+          type: string
+      required:
+      - type
+      - source
+      - target
+      - filter
+      - value_to_extract
+      type: object
+    LogsArrayProcessorOperationSelectType:
+      description: Operation type.
+      enum:
+      - select
+      example: select
+      type: string
+      x-enum-varnames:
+      - SELECT
+    LogsArrayProcessorType:
+      default: array-processor
+      description: Type of logs array processor.
+      enum:
+      - array-processor
+      example: array-processor
+      type: string
+      x-enum-varnames:
+      - ARRAY_PROCESSOR
     LogsAttributeRemapper:
       description: 'The remapper processor remaps any source attribute(s) or tag to
         another target attribute or tag.
@@ -6060,6 +6197,7 @@ components:
       - $ref: '#/components/schemas/ReferenceTableLogsLookupProcessor'
       - $ref: '#/components/schemas/LogsTraceRemapper'
       - $ref: '#/components/schemas/LogsSpanRemapper'
+      - $ref: '#/components/schemas/LogsArrayProcessor'
     LogsQueryCompute:
       description: Define computation for a log query.
       properties:

docs/datadog_api_client.v1.model.rst

@@ -1572,6 +1572,69 @@ datadog\_api\_client.v1.model.logs\_arithmetic\_processor\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.logs\_array\_processor module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_append module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_append
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_append\_type module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_append_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_length module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_length
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_length\_type module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_length_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_select module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_select
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_operation\_select\_type module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_operation_select_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.logs\_array\_processor\_type module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.logs_array_processor_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.logs\_attribute\_remapper module
 --------------------------------------------------------------
 

examples/v1/logs-pipelines/CreateLogsPipeline_1248402480.py

@@ -0,0 +1,39 @@
+"""
+Create a pipeline with Array Processor Append Operation returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi
+from datadog_api_client.v1.model.logs_array_processor import LogsArrayProcessor
+from datadog_api_client.v1.model.logs_array_processor_operation_append import LogsArrayProcessorOperationAppend
+from datadog_api_client.v1.model.logs_array_processor_operation_append_type import LogsArrayProcessorOperationAppendType
+from datadog_api_client.v1.model.logs_array_processor_type import LogsArrayProcessorType
+from datadog_api_client.v1.model.logs_filter import LogsFilter
+from datadog_api_client.v1.model.logs_pipeline import LogsPipeline
+
+body = LogsPipeline(
+    filter=LogsFilter(
+        query="source:python",
+    ),
+    name="testPipelineArrayAppend",
+    processors=[
+        LogsArrayProcessor(
+            type=LogsArrayProcessorType.ARRAY_PROCESSOR,
+            is_enabled=True,
+            name="append_ip_to_array",
+            operation=LogsArrayProcessorOperationAppend(
+                type=LogsArrayProcessorOperationAppendType.APPEND,
+                source="network.client.ip",
+                target="sourceIps",
+            ),
+        ),
+    ],
+    tags=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsPipelinesApi(api_client)
+    response = api_instance.create_logs_pipeline(body=body)
+
+    print(response)

examples/v1/logs-pipelines/CreateLogsPipeline_1267211320.py

@@ -0,0 +1,41 @@
+"""
+Create a pipeline with Array Processor Select Operation returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi
+from datadog_api_client.v1.model.logs_array_processor import LogsArrayProcessor
+from datadog_api_client.v1.model.logs_array_processor_operation_select import LogsArrayProcessorOperationSelect
+from datadog_api_client.v1.model.logs_array_processor_operation_select_type import LogsArrayProcessorOperationSelectType
+from datadog_api_client.v1.model.logs_array_processor_type import LogsArrayProcessorType
+from datadog_api_client.v1.model.logs_filter import LogsFilter
+from datadog_api_client.v1.model.logs_pipeline import LogsPipeline
+
+body = LogsPipeline(
+    filter=LogsFilter(
+        query="source:python",
+    ),
+    name="testPipelineArraySelect",
+    processors=[
+        LogsArrayProcessor(
+            type=LogsArrayProcessorType.ARRAY_PROCESSOR,
+            is_enabled=True,
+            name="extract_referrer",
+            operation=LogsArrayProcessorOperationSelect(
+                type=LogsArrayProcessorOperationSelectType.SELECT,
+                source="httpRequest.headers",
+                target="referrer",
+                filter="name:Referrer",
+                value_to_extract="value",
+            ),
+        ),
+    ],
+    tags=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsPipelinesApi(api_client)
+    response = api_instance.create_logs_pipeline(body=body)
+
+    print(response)

examples/v1/logs-pipelines/CreateLogsPipeline_1271012410.py

@@ -0,0 +1,39 @@
+"""
+Create a pipeline with Array Processor Length Operation returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi
+from datadog_api_client.v1.model.logs_array_processor import LogsArrayProcessor
+from datadog_api_client.v1.model.logs_array_processor_operation_length import LogsArrayProcessorOperationLength
+from datadog_api_client.v1.model.logs_array_processor_operation_length_type import LogsArrayProcessorOperationLengthType
+from datadog_api_client.v1.model.logs_array_processor_type import LogsArrayProcessorType
+from datadog_api_client.v1.model.logs_filter import LogsFilter
+from datadog_api_client.v1.model.logs_pipeline import LogsPipeline
+
+body = LogsPipeline(
+    filter=LogsFilter(
+        query="source:python",
+    ),
+    name="testPipelineArrayLength",
+    processors=[
+        LogsArrayProcessor(
+            type=LogsArrayProcessorType.ARRAY_PROCESSOR,
+            is_enabled=True,
+            name="count_tags",
+            operation=LogsArrayProcessorOperationLength(
+                type=LogsArrayProcessorOperationLengthType.LENGTH,
+                source="tags",
+                target="tagCount",
+            ),
+        ),
+    ],
+    tags=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = LogsPipelinesApi(api_client)
+    response = api_instance.create_logs_pipeline(body=body)
+
+    print(response)