Skip to content

Commit 1fd3f6b

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit bd3c75a of spec repo
1 parent 2639971 commit 1fd3f6b

19 files changed

+954
-1
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41139,6 +41139,7 @@ components:
4113941139
example: CloudTrail Account Change
4114041140
oneOf:
4114141141
- $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingLibrary'
41142+
- $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustom'
4114241143
ObservabilityPipelineOcsfMapperProcessorType:
4114341144
default: ocsf_mapper
4114441145
description: The processor type. The value should always be `ocsf_mapper`.
@@ -41148,6 +41149,116 @@ components:
4114841149
type: string
4114941150
x-enum-varnames:
4115041151
- OCSF_MAPPER
41152+
ObservabilityPipelineOcsfMappingCustom:
41153+
description: Custom OCSF mapping configuration for transforming logs.
41154+
properties:
41155+
mapping:
41156+
description: A list of field mapping rules for transforming log fields to
41157+
OCSF schema fields.
41158+
items:
41159+
$ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomFieldMapping'
41160+
type: array
41161+
metadata:
41162+
$ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomMetadata'
41163+
version:
41164+
description: The version of the custom mapping configuration.
41165+
example: 1
41166+
format: int64
41167+
type: integer
41168+
required:
41169+
- mapping
41170+
- metadata
41171+
- version
41172+
type: object
41173+
ObservabilityPipelineOcsfMappingCustomFieldMapping:
41174+
description: Defines a single field mapping rule for transforming a source field
41175+
to an OCSF destination field.
41176+
properties:
41177+
default:
41178+
description: The default value to use if the source field is missing or
41179+
empty.
41180+
example: ''
41181+
dest:
41182+
description: The destination OCSF field path.
41183+
example: device.type
41184+
type: string
41185+
lookup:
41186+
$ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookup'
41187+
source:
41188+
description: The source field path from the log event.
41189+
example: host.type
41190+
sources:
41191+
description: Multiple source field paths for combined mapping.
41192+
example:
41193+
- field1
41194+
- field2
41195+
value:
41196+
description: A static value to use for the destination field.
41197+
example: static_value
41198+
required:
41199+
- dest
41200+
type: object
41201+
ObservabilityPipelineOcsfMappingCustomLookup:
41202+
description: Lookup table configuration for mapping source values to destination
41203+
values.
41204+
properties:
41205+
default:
41206+
description: The default value to use if no lookup match is found.
41207+
example: unknown
41208+
table:
41209+
description: A list of lookup table entries for value transformation.
41210+
items:
41211+
$ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookupTableEntry'
41212+
type: array
41213+
type: object
41214+
ObservabilityPipelineOcsfMappingCustomLookupTableEntry:
41215+
description: A single entry in a lookup table for value transformation.
41216+
properties:
41217+
contains:
41218+
description: The substring to match in the source value.
41219+
example: Desktop
41220+
type: string
41221+
equals:
41222+
description: The exact value to match in the source.
41223+
example: desktop
41224+
equals_source:
41225+
description: The source field to match against.
41226+
example: device_type
41227+
type: string
41228+
matches:
41229+
description: A regex pattern to match in the source value.
41230+
example: ^Desktop.*
41231+
type: string
41232+
not_matches:
41233+
description: A regex pattern that must not match the source value.
41234+
example: ^Mobile.*
41235+
type: string
41236+
value:
41237+
description: The value to use when a match is found.
41238+
example: desktop
41239+
type: object
41240+
ObservabilityPipelineOcsfMappingCustomMetadata:
41241+
description: Metadata for the custom OCSF mapping.
41242+
properties:
41243+
class:
41244+
description: The OCSF event class name.
41245+
example: Device Inventory Info
41246+
type: string
41247+
profiles:
41248+
description: A list of OCSF profiles to apply.
41249+
example:
41250+
- container
41251+
items:
41252+
type: string
41253+
type: array
41254+
version:
41255+
description: The OCSF schema version.
41256+
example: 1.3.0
41257+
type: string
41258+
required:
41259+
- class
41260+
- version
41261+
type: object
4115141262
ObservabilityPipelineOcsfMappingLibrary:
4115241263
description: Predefined library mappings for common log formats.
4115341264
enum:

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17749,6 +17749,41 @@ datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapper\_processor\_
1774917749
:members:
1775017750
:show-inheritance:
1775117751

17752+
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_custom module
17753+
-----------------------------------------------------------------------------------
17754+
17755+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom
17756+
:members:
17757+
:show-inheritance:
17758+
17759+
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_custom\_field\_mapping module
17760+
---------------------------------------------------------------------------------------------------
17761+
17762+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_field_mapping
17763+
:members:
17764+
:show-inheritance:
17765+
17766+
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_custom\_lookup module
17767+
-------------------------------------------------------------------------------------------
17768+
17769+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_lookup
17770+
:members:
17771+
:show-inheritance:
17772+
17773+
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_custom\_lookup\_table\_entry module
17774+
---------------------------------------------------------------------------------------------------------
17775+
17776+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_lookup_table_entry
17777+
:members:
17778+
:show-inheritance:
17779+
17780+
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_custom\_metadata module
17781+
---------------------------------------------------------------------------------------------
17782+
17783+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_metadata
17784+
:members:
17785+
:show-inheritance:
17786+
1775217787
datadog\_api\_client.v2.model.observability\_pipeline\_ocsf\_mapping\_library module
1775317788
------------------------------------------------------------------------------------
1775417789

‎examples/v2/observability-pipelines/ValidatePipeline_3024756866.py‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
"""
2+
Validate an observability pipeline with OCSF mapper custom mapping returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.observability_pipelines_api import ObservabilityPipelinesApi
7+
from datadog_api_client.v2.model.observability_pipeline_config import ObservabilityPipelineConfig
8+
from datadog_api_client.v2.model.observability_pipeline_config_processor_group import (
9+
ObservabilityPipelineConfigProcessorGroup,
10+
)
11+
from datadog_api_client.v2.model.observability_pipeline_data_attributes import ObservabilityPipelineDataAttributes
12+
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
13+
ObservabilityPipelineDatadogAgentSource,
14+
)
15+
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source_type import (
16+
ObservabilityPipelineDatadogAgentSourceType,
17+
)
18+
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
19+
ObservabilityPipelineDatadogLogsDestination,
20+
)
21+
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
22+
ObservabilityPipelineDatadogLogsDestinationType,
23+
)
24+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor import (
25+
ObservabilityPipelineOcsfMapperProcessor,
26+
)
27+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_mapping import (
28+
ObservabilityPipelineOcsfMapperProcessorMapping,
29+
)
30+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_type import (
31+
ObservabilityPipelineOcsfMapperProcessorType,
32+
)
33+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom import (
34+
ObservabilityPipelineOcsfMappingCustom,
35+
)
36+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_field_mapping import (
37+
ObservabilityPipelineOcsfMappingCustomFieldMapping,
38+
)
39+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_lookup import (
40+
ObservabilityPipelineOcsfMappingCustomLookup,
41+
)
42+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_lookup_table_entry import (
43+
ObservabilityPipelineOcsfMappingCustomLookupTableEntry,
44+
)
45+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_custom_metadata import (
46+
ObservabilityPipelineOcsfMappingCustomMetadata,
47+
)
48+
from datadog_api_client.v2.model.observability_pipeline_spec import ObservabilityPipelineSpec
49+
from datadog_api_client.v2.model.observability_pipeline_spec_data import ObservabilityPipelineSpecData
50+
51+
body = ObservabilityPipelineSpec(
52+
data=ObservabilityPipelineSpecData(
53+
attributes=ObservabilityPipelineDataAttributes(
54+
config=ObservabilityPipelineConfig(
55+
destinations=[
56+
ObservabilityPipelineDatadogLogsDestination(
57+
id="datadog-logs-destination",
58+
inputs=[
59+
"my-processor-group",
60+
],
61+
type=ObservabilityPipelineDatadogLogsDestinationType.DATADOG_LOGS,
62+
),
63+
],
64+
processor_groups=[
65+
ObservabilityPipelineConfigProcessorGroup(
66+
enabled=True,
67+
id="my-processor-group",
68+
include="service:my-service",
69+
inputs=[
70+
"datadog-agent-source",
71+
],
72+
processors=[
73+
ObservabilityPipelineOcsfMapperProcessor(
74+
enabled=True,
75+
id="ocsf-mapper-processor",
76+
include="service:my-service",
77+
type=ObservabilityPipelineOcsfMapperProcessorType.OCSF_MAPPER,
78+
mappings=[
79+
ObservabilityPipelineOcsfMapperProcessorMapping(
80+
include="source:custom",
81+
mapping=ObservabilityPipelineOcsfMappingCustom(
82+
version=1,
83+
metadata=ObservabilityPipelineOcsfMappingCustomMetadata(
84+
_class="Device Inventory Info",
85+
profiles=[
86+
"container",
87+
],
88+
version="1.3.0",
89+
),
90+
mapping=[
91+
ObservabilityPipelineOcsfMappingCustomFieldMapping(
92+
dest="time",
93+
source="timestamp",
94+
default="",
95+
),
96+
ObservabilityPipelineOcsfMappingCustomFieldMapping(
97+
dest="severity",
98+
source="level",
99+
default="",
100+
),
101+
ObservabilityPipelineOcsfMappingCustomFieldMapping(
102+
dest="device.type",
103+
source="host.type",
104+
default="",
105+
lookup=ObservabilityPipelineOcsfMappingCustomLookup(
106+
table=[
107+
ObservabilityPipelineOcsfMappingCustomLookupTableEntry(
108+
contains="Desktop",
109+
value="desktop",
110+
),
111+
],
112+
),
113+
),
114+
],
115+
),
116+
),
117+
],
118+
),
119+
],
120+
),
121+
],
122+
sources=[
123+
ObservabilityPipelineDatadogAgentSource(
124+
id="datadog-agent-source",
125+
type=ObservabilityPipelineDatadogAgentSourceType.DATADOG_AGENT,
126+
),
127+
],
128+
),
129+
name="OCSF Custom Mapper Pipeline",
130+
),
131+
type="pipelines",
132+
),
133+
)
134+
135+
configuration = Configuration()
136+
with ApiClient(configuration) as api_client:
137+
api_instance = ObservabilityPipelinesApi(api_client)
138+
response = api_instance.validate_pipeline(body=body)
139+
140+
print(response)

‎examples/v2/observability-pipelines/ValidatePipeline_3565101276.py‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
"""
2+
Validate an observability pipeline with OCSF mapper library mapping returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.observability_pipelines_api import ObservabilityPipelinesApi
7+
from datadog_api_client.v2.model.observability_pipeline_config import ObservabilityPipelineConfig
8+
from datadog_api_client.v2.model.observability_pipeline_config_processor_group import (
9+
ObservabilityPipelineConfigProcessorGroup,
10+
)
11+
from datadog_api_client.v2.model.observability_pipeline_data_attributes import ObservabilityPipelineDataAttributes
12+
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
13+
ObservabilityPipelineDatadogAgentSource,
14+
)
15+
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source_type import (
16+
ObservabilityPipelineDatadogAgentSourceType,
17+
)
18+
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
19+
ObservabilityPipelineDatadogLogsDestination,
20+
)
21+
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
22+
ObservabilityPipelineDatadogLogsDestinationType,
23+
)
24+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor import (
25+
ObservabilityPipelineOcsfMapperProcessor,
26+
)
27+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_mapping import (
28+
ObservabilityPipelineOcsfMapperProcessorMapping,
29+
)
30+
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_type import (
31+
ObservabilityPipelineOcsfMapperProcessorType,
32+
)
33+
from datadog_api_client.v2.model.observability_pipeline_spec import ObservabilityPipelineSpec
34+
from datadog_api_client.v2.model.observability_pipeline_spec_data import ObservabilityPipelineSpecData
35+
36+
body = ObservabilityPipelineSpec(
37+
data=ObservabilityPipelineSpecData(
38+
attributes=ObservabilityPipelineDataAttributes(
39+
config=ObservabilityPipelineConfig(
40+
destinations=[
41+
ObservabilityPipelineDatadogLogsDestination(
42+
id="datadog-logs-destination",
43+
inputs=[
44+
"my-processor-group",
45+
],
46+
type=ObservabilityPipelineDatadogLogsDestinationType.DATADOG_LOGS,
47+
),
48+
],
49+
processor_groups=[
50+
ObservabilityPipelineConfigProcessorGroup(
51+
enabled=True,
52+
id="my-processor-group",
53+
include="service:my-service",
54+
inputs=[
55+
"datadog-agent-source",
56+
],
57+
processors=[
58+
ObservabilityPipelineOcsfMapperProcessor(
59+
enabled=True,
60+
id="ocsf-mapper-processor",
61+
include="service:my-service",
62+
type=ObservabilityPipelineOcsfMapperProcessorType.OCSF_MAPPER,
63+
mappings=[
64+
ObservabilityPipelineOcsfMapperProcessorMapping(
65+
include="source:cloudtrail",
66+
mapping="CloudTrail Account Change",
67+
),
68+
],
69+
),
70+
],
71+
),
72+
],
73+
sources=[
74+
ObservabilityPipelineDatadogAgentSource(
75+
id="datadog-agent-source",
76+
type=ObservabilityPipelineDatadogAgentSourceType.DATADOG_AGENT,
77+
),
78+
],
79+
),
80+
name="OCSF Mapper Pipeline",
81+
),
82+
type="pipelines",
83+
),
84+
)
85+
86+
configuration = Configuration()
87+
with ApiClient(configuration) as api_client:
88+
api_instance = ObservabilityPipelinesApi(api_client)
89+
response = api_instance.validate_pipeline(body=body)
90+
91+
print(response)

0 commit comments

Comments
 (0)