Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 178 additions & 10 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35178,6 +35178,43 @@ components:
type: string
x-enum-varnames:
- ADD_FIELDS
ObservabilityPipelineAddHostnameProcessor:
description: The `add_hostname` processor adds the hostname to log events.
properties:
display_name:
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Whether this processor is enabled.
example: true
type: boolean
id:
description: The unique identifier for this component. Used to reference
this component in other parts of the pipeline (for example, as the `input`
to downstream components).
example: add-hostname-processor
type: string
include:
description: A Datadog search query used to determine which logs this processor
targets.
example: service:my-service
type: string
type:
$ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessorType'
required:
- id
- type
- include
- enabled
type: object
ObservabilityPipelineAddHostnameProcessorType:
default: add_hostname
description: The processor type. The value should always be `add_hostname`.
enum:
- add_hostname
example: add_hostname
type: string
x-enum-varnames:
- ADD_HOSTNAME
ObservabilityPipelineAmazonDataFirehoseSource:
description: The `amazon_data_firehose` source ingests logs from AWS Data Firehose.
properties:
Expand Down Expand Up @@ -35600,24 +35637,27 @@ components:
ObservabilityPipelineConfigProcessorItem:
description: A processor for the pipeline.
oneOf:
- $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineFilterProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineSampleProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor'
- $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
ObservabilityPipelineConfigSourceItem:
description: A data source for the pipeline.
oneOf:
Expand Down Expand Up @@ -37279,6 +37319,72 @@ components:
type: string
x-enum-varnames:
- PARSE_JSON
ObservabilityPipelineParseXMLProcessor:
description: The `parse_xml` processor parses XML from a specified field and
extracts it into the event.
properties:
always_use_text_key:
description: Whether to always use a text key for element content.
type: boolean
attr_prefix:
description: The prefix to use for XML attributes in the parsed output.
type: string
display_name:
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Whether this processor is enabled.
example: true
type: boolean
field:
description: The name of the log field that contains an XML string.
example: message
type: string
id:
description: The unique identifier for this component. Used to reference
this component in other parts of the pipeline (for example, as the `input`
to downstream components).
example: parse-xml-processor
type: string
include:
description: A Datadog search query used to determine which logs this processor
targets.
example: service:my-service
type: string
include_attr:
description: Whether to include XML attributes in the parsed output.
type: boolean
parse_bool:
description: Whether to parse boolean values from strings.
type: boolean
parse_null:
description: Whether to parse null values.
type: boolean
parse_number:
description: Whether to parse numeric values from strings.
type: boolean
text_key:
description: The key name to use for text content within XML elements. Must
be at least 1 character if specified.
minLength: 1
type: string
type:
$ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessorType'
required:
- id
- type
- include
- field
- enabled
type: object
ObservabilityPipelineParseXMLProcessorType:
default: parse_xml
description: The processor type. The value should always be `parse_xml`.
enum:
- parse_xml
example: parse_xml
type: string
x-enum-varnames:
- PARSE_XML
ObservabilityPipelinePipelineKafkaSourceSaslMechanism:
description: SASL mechanism used for Kafka authentication.
enum:
Expand Down Expand Up @@ -38442,6 +38548,68 @@ components:
- type
- attributes
type: object
ObservabilityPipelineSplitArrayProcessor:
description: The `split_array` processor splits array fields into separate events
based on configured rules.
properties:
arrays:
description: A list of array split configurations.
items:
$ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig'
maxItems: 15
minItems: 1
type: array
display_name:
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Whether this processor is enabled.
example: true
type: boolean
id:
description: The unique identifier for this component. Used to reference
this component in other parts of the pipeline (for example, as the `input`
to downstream components).
example: split-array-processor
type: string
include:
description: A Datadog search query used to determine which logs this processor
targets. For split_array, this should typically be `*`.
example: '*'
type: string
type:
$ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorType'
required:
- id
- type
- include
- arrays
- enabled
type: object
ObservabilityPipelineSplitArrayProcessorArrayConfig:
description: Configuration for a single array split operation.
properties:
field:
description: The path to the array field to split.
example: tags
type: string
include:
description: A Datadog search query used to determine which logs this array
split operation targets.
example: '*'
type: string
required:
- include
- field
type: object
ObservabilityPipelineSplitArrayProcessorType:
default: split_array
description: The processor type. The value should always be `split_array`.
enum:
- split_array
example: split_array
type: string
x-enum-varnames:
- SPLIT_ARRAY
ObservabilityPipelineSplunkHecDestination:
description: The `splunk_hec` destination forwards logs to Splunk using the
HTTP Event Collector (HEC).
Expand Down
49 changes: 49 additions & 0 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15369,6 +15369,20 @@ datadog\_api\_client.v2.model.observability\_pipeline\_add\_fields\_processor\_t
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_add\_hostname\_processor module
--------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_add_hostname_processor
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_add\_hostname\_processor\_type module
--------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_add_hostname_processor_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_amazon\_data\_firehose\_source module
--------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -16153,6 +16167,20 @@ datadog\_api\_client.v2.model.observability\_pipeline\_parse\_json\_processor\_t
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_parse\_xml\_processor module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_parse_xml_processor
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_parse\_xml\_processor\_type module
-----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_parse_xml_processor_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_pipeline\_kafka\_source\_sasl\_mechanism module
------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -16720,6 +16748,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_spec\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_split\_array\_processor module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_split_array_processor
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_split\_array\_processor\_array\_config module
----------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_split_array_processor_array_config
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_split\_array\_processor\_type module
-------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_split_array_processor_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination module
--------------------------------------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.
from __future__ import annotations

from typing import Union, TYPE_CHECKING

from datadog_api_client.model_utils import (
ModelNormal,
cached_property,
unset,
UnsetType,
)


if TYPE_CHECKING:
from datadog_api_client.v2.model.observability_pipeline_add_hostname_processor_type import (
ObservabilityPipelineAddHostnameProcessorType,
)


class ObservabilityPipelineAddHostnameProcessor(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_add_hostname_processor_type import (
ObservabilityPipelineAddHostnameProcessorType,
)

return {
"display_name": (str,),
"enabled": (bool,),
"id": (str,),
"include": (str,),
"type": (ObservabilityPipelineAddHostnameProcessorType,),
}

attribute_map = {
"display_name": "display_name",
"enabled": "enabled",
"id": "id",
"include": "include",
"type": "type",
}

def __init__(
self_,
enabled: bool,
id: str,
include: str,
type: ObservabilityPipelineAddHostnameProcessorType,
display_name: Union[str, UnsetType] = unset,
**kwargs,
):
"""
The ``add_hostname`` processor adds the hostname to log events.

:param display_name: The display name for a component.
:type display_name: str, optional

:param enabled: Whether this processor is enabled.
:type enabled: bool

:param id: The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the ``input`` to downstream components).
:type id: str

:param include: A Datadog search query used to determine which logs this processor targets.
:type include: str

:param type: The processor type. The value should always be ``add_hostname``.
:type type: ObservabilityPipelineAddHostnameProcessorType
"""
if display_name is not unset:
kwargs["display_name"] = display_name
super().__init__(kwargs)

self_.enabled = enabled
self_.id = id
self_.include = include
self_.type = type
Loading
Loading