@@ -25145,6 +25145,7 @@ components:
25145
25145
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
25146
25146
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
25147
25147
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
25148
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
25148
25149
ObservabilityPipelineConfigProcessorItem:
25149
25150
description: A processor for the pipeline.
25150
25151
oneOf:
@@ -25164,6 +25165,7 @@ components:
25164
25165
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
25165
25166
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
25166
25167
- $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor'
25168
+ - $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorProcessor'
25167
25169
ObservabilityPipelineConfigSourceItem:
25168
25170
description: A data source for the pipeline.
25169
25171
oneOf:
@@ -25182,6 +25184,87 @@ components:
25182
25184
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
25183
25185
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
25184
25186
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
25187
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
25188
+ ObservabilityPipelineCustomProcessorProcessor:
25189
+ description: The `custom_processor` processor transforms events using [Vector
25190
+ Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
25191
+ advanced filtering capabilities.
25192
+ properties:
25193
+ id:
25194
+ description: The unique identifier for this processor.
25195
+ example: remap-vrl-processor
25196
+ type: string
25197
+ include:
25198
+ default: '*'
25199
+ description: A Datadog search query used to determine which logs this processor
25200
+ targets. This field should always be set to `*` for the custom_processor
25201
+ processor.
25202
+ example: '*'
25203
+ type: string
25204
+ inputs:
25205
+ description: A list of component IDs whose output is used as the input for
25206
+ this processor.
25207
+ example:
25208
+ - datadog-agent-source
25209
+ items:
25210
+ type: string
25211
+ type: array
25212
+ remaps:
25213
+ description: Array of VRL remap rules.
25214
+ items:
25215
+ $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorProcessorRemap'
25216
+ minItems: 1
25217
+ type: array
25218
+ type:
25219
+ $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorProcessorType'
25220
+ required:
25221
+ - id
25222
+ - type
25223
+ - include
25224
+ - remaps
25225
+ - inputs
25226
+ type: object
25227
+ ObservabilityPipelineCustomProcessorProcessorRemap:
25228
+ description: Defines a single VRL remap rule with its own filtering and transformation
25229
+ logic.
25230
+ properties:
25231
+ drop_on_error:
25232
+ default: false
25233
+ description: Whether to drop events that caused errors during processing.
25234
+ example: false
25235
+ type: boolean
25236
+ enabled:
25237
+ default: true
25238
+ description: Whether this remap rule is enabled.
25239
+ example: true
25240
+ type: boolean
25241
+ include:
25242
+ description: A Datadog search query used to filter events for this specific
25243
+ remap rule.
25244
+ example: service:web
25245
+ type: string
25246
+ name:
25247
+ description: A descriptive name for this remap rule.
25248
+ example: Parse JSON from message field
25249
+ type: string
25250
+ source:
25251
+ description: The VRL script source code that defines the processing logic.
25252
+ example: . = parse_json!(.message)
25253
+ type: string
25254
+ required:
25255
+ - include
25256
+ - name
25257
+ - source
25258
+ type: object
25259
+ ObservabilityPipelineCustomProcessorProcessorType:
25260
+ default: custom_processor
25261
+ description: The processor type. The value should always be `custom_processor`.
25262
+ enum:
25263
+ - custom_processor
25264
+ example: custom_processor
25265
+ type: string
25266
+ x-enum-varnames:
25267
+ - CUSTOM_PROCESSOR
25185
25268
ObservabilityPipelineData:
25186
25269
description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
25187
25270
properties:
@@ -27465,6 +27548,278 @@ components:
27465
27548
type: string
27466
27549
x-enum-varnames:
27467
27550
- SENTINEL_ONE
27551
+ ObservabilityPipelineSocketDestination:
27552
+ description: 'The `socket` destination sends logs over TCP or UDP to a remote
27553
+ server.
27554
+
27555
+ '
27556
+ properties:
27557
+ encoding:
27558
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
27559
+ framing:
27560
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
27561
+ id:
27562
+ description: The unique identifier for this component.
27563
+ example: socket-destination
27564
+ type: string
27565
+ inputs:
27566
+ description: A list of component IDs whose output is used as the `input`
27567
+ for this component.
27568
+ example:
27569
+ - filter-processor
27570
+ items:
27571
+ type: string
27572
+ type: array
27573
+ mode:
27574
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
27575
+ tls:
27576
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27577
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27578
+ type:
27579
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
27580
+ required:
27581
+ - id
27582
+ - type
27583
+ - inputs
27584
+ - encoding
27585
+ - framing
27586
+ - mode
27587
+ type: object
27588
+ ObservabilityPipelineSocketDestinationEncoding:
27589
+ description: Encoding format for log events.
27590
+ enum:
27591
+ - json
27592
+ - raw_message
27593
+ example: json
27594
+ type: string
27595
+ x-enum-varnames:
27596
+ - JSON
27597
+ - RAW_MESSAGE
27598
+ ObservabilityPipelineSocketDestinationFraming:
27599
+ description: Framing method configuration.
27600
+ oneOf:
27601
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
27602
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
27603
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
27604
+ ObservabilityPipelineSocketDestinationFramingBytes:
27605
+ description: Event data is not delimited at all.
27606
+ properties:
27607
+ method:
27608
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
27609
+ required:
27610
+ - method
27611
+ type: object
27612
+ ObservabilityPipelineSocketDestinationFramingBytesMethod:
27613
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
27614
+ object.
27615
+ enum:
27616
+ - bytes
27617
+ example: bytes
27618
+ type: string
27619
+ x-enum-varnames:
27620
+ - BYTES
27621
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
27622
+ description: Each log event is separated using the specified delimiter character.
27623
+ properties:
27624
+ delimiter:
27625
+ description: A single ASCII character used as a delimiter.
27626
+ example: '|'
27627
+ maxLength: 1
27628
+ minLength: 1
27629
+ type: string
27630
+ method:
27631
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
27632
+ required:
27633
+ - method
27634
+ - delimiter
27635
+ type: object
27636
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
27637
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
27638
+ object.
27639
+ enum:
27640
+ - character_delimited
27641
+ example: character_delimited
27642
+ type: string
27643
+ x-enum-varnames:
27644
+ - CHARACTER_DELIMITED
27645
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
27646
+ description: Each log event is delimited by a newline character.
27647
+ properties:
27648
+ method:
27649
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
27650
+ required:
27651
+ - method
27652
+ type: object
27653
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
27654
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
27655
+ object.
27656
+ enum:
27657
+ - newline_delimited
27658
+ example: newline_delimited
27659
+ type: string
27660
+ x-enum-varnames:
27661
+ - NEWLINE_DELIMITED
27662
+ ObservabilityPipelineSocketDestinationMode:
27663
+ description: Protocol used to send logs.
27664
+ enum:
27665
+ - tcp
27666
+ - udp
27667
+ example: tcp
27668
+ type: string
27669
+ x-enum-varnames:
27670
+ - TCP
27671
+ - UDP
27672
+ ObservabilityPipelineSocketDestinationType:
27673
+ default: socket
27674
+ description: The destination type. The value should always be `socket`.
27675
+ enum:
27676
+ - socket
27677
+ example: socket
27678
+ type: string
27679
+ x-enum-varnames:
27680
+ - SOCKET
27681
+ ObservabilityPipelineSocketSource:
27682
+ description: 'The `socket` source ingests logs over TCP or UDP.
27683
+
27684
+ '
27685
+ properties:
27686
+ framing:
27687
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
27688
+ id:
27689
+ description: The unique identifier for this component. Used to reference
27690
+ this component in other parts of the pipeline (e.g., as input to downstream
27691
+ components).
27692
+ example: socket-source
27693
+ type: string
27694
+ mode:
27695
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
27696
+ tls:
27697
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27698
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27699
+ type:
27700
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
27701
+ required:
27702
+ - id
27703
+ - type
27704
+ - mode
27705
+ - framing
27706
+ type: object
27707
+ ObservabilityPipelineSocketSourceFraming:
27708
+ description: Framing method configuration for the socket source.
27709
+ oneOf:
27710
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
27711
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
27712
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
27713
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
27714
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
27715
+ ObservabilityPipelineSocketSourceFramingBytes:
27716
+ description: Byte frames are passed through as-is according to the underlying
27717
+ I/O boundaries (for example, split between messages or stream segments).
27718
+ properties:
27719
+ method:
27720
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
27721
+ required:
27722
+ - method
27723
+ type: object
27724
+ ObservabilityPipelineSocketSourceFramingBytesMethod:
27725
+ description: Byte frames are passed through as-is according to the underlying
27726
+ I/O boundaries (for example, split between messages or stream segments).
27727
+ enum:
27728
+ - bytes
27729
+ example: bytes
27730
+ type: string
27731
+ x-enum-varnames:
27732
+ - BYTES
27733
+ ObservabilityPipelineSocketSourceFramingCharacterDelimited:
27734
+ description: Byte frames which are delimited by a chosen character.
27735
+ properties:
27736
+ delimiter:
27737
+ description: A single ASCII character used to delimit events.
27738
+ example: '|'
27739
+ maxLength: 1
27740
+ minLength: 1
27741
+ type: string
27742
+ method:
27743
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
27744
+ required:
27745
+ - method
27746
+ - delimiter
27747
+ type: object
27748
+ ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
27749
+ description: Byte frames which are delimited by a chosen character.
27750
+ enum:
27751
+ - character_delimited
27752
+ example: character_delimited
27753
+ type: string
27754
+ x-enum-varnames:
27755
+ - CHARACTER_DELIMITED
27756
+ ObservabilityPipelineSocketSourceFramingChunkedGelf:
27757
+ description: Byte frames which are chunked GELF messages.
27758
+ properties:
27759
+ method:
27760
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
27761
+ required:
27762
+ - method
27763
+ type: object
27764
+ ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
27765
+ description: Byte frames which are chunked GELF messages.
27766
+ enum:
27767
+ - chunked_gelf
27768
+ example: chunked_gelf
27769
+ type: string
27770
+ x-enum-varnames:
27771
+ - CHUNKED_GELF
27772
+ ObservabilityPipelineSocketSourceFramingNewlineDelimited:
27773
+ description: Byte frames which are delimited by a newline character.
27774
+ properties:
27775
+ method:
27776
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
27777
+ required:
27778
+ - method
27779
+ type: object
27780
+ ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
27781
+ description: Byte frames which are delimited by a newline character.
27782
+ enum:
27783
+ - newline_delimited
27784
+ example: newline_delimited
27785
+ type: string
27786
+ x-enum-varnames:
27787
+ - NEWLINE_DELIMITED
27788
+ ObservabilityPipelineSocketSourceFramingOctetCounting:
27789
+ description: Byte frames according to the octet counting format as per RFC6587.
27790
+ properties:
27791
+ method:
27792
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
27793
+ required:
27794
+ - method
27795
+ type: object
27796
+ ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
27797
+ description: Byte frames according to the octet counting format as per RFC6587.
27798
+ enum:
27799
+ - octet_counting
27800
+ example: octet_counting
27801
+ type: string
27802
+ x-enum-varnames:
27803
+ - OCTET_COUNTING
27804
+ ObservabilityPipelineSocketSourceMode:
27805
+ description: Protocol used to receive logs.
27806
+ enum:
27807
+ - tcp
27808
+ - udp
27809
+ example: tcp
27810
+ type: string
27811
+ x-enum-varnames:
27812
+ - TCP
27813
+ - UDP
27814
+ ObservabilityPipelineSocketSourceType:
27815
+ default: socket
27816
+ description: The source type. The value should always be `socket`.
27817
+ enum:
27818
+ - socket
27819
+ example: socket
27820
+ type: string
27821
+ x-enum-varnames:
27822
+ - SOCKET
27468
27823
ObservabilityPipelineSpec:
27469
27824
description: Input schema representing an observability pipeline configuration.
27470
27825
Used in create and validate requests.
0 commit comments