@@ -24748,6 +24748,7 @@ components:
24748
24748
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
24749
24749
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
24750
24750
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
24751
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
24751
24752
ObservabilityPipelineConfigProcessorItem:
24752
24753
description: A processor for the pipeline.
24753
24754
oneOf:
@@ -24785,6 +24786,7 @@ components:
24785
24786
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
24786
24787
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
24787
24788
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
24789
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
24788
24790
ObservabilityPipelineData:
24789
24791
description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
24790
24792
properties:
@@ -27068,6 +27070,278 @@ components:
27068
27070
type: string
27069
27071
x-enum-varnames:
27070
27072
- SENTINEL_ONE
27073
+ ObservabilityPipelineSocketDestination:
27074
+ description: 'The `socket` destination sends logs over TCP or UDP to a remote
27075
+ server.
27076
+
27077
+ '
27078
+ properties:
27079
+ encoding:
27080
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
27081
+ framing:
27082
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
27083
+ id:
27084
+ description: The unique identifier for this component.
27085
+ example: socket-destination
27086
+ type: string
27087
+ inputs:
27088
+ description: A list of component IDs whose output is used as the `input`
27089
+ for this component.
27090
+ example:
27091
+ - filter-processor
27092
+ items:
27093
+ type: string
27094
+ type: array
27095
+ mode:
27096
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
27097
+ tls:
27098
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27099
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27100
+ type:
27101
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
27102
+ required:
27103
+ - id
27104
+ - type
27105
+ - inputs
27106
+ - encoding
27107
+ - framing
27108
+ - mode
27109
+ type: object
27110
+ ObservabilityPipelineSocketDestinationEncoding:
27111
+ description: Encoding format for log events.
27112
+ enum:
27113
+ - json
27114
+ - raw_message
27115
+ example: json
27116
+ type: string
27117
+ x-enum-varnames:
27118
+ - JSON
27119
+ - RAW_MESSAGE
27120
+ ObservabilityPipelineSocketDestinationFraming:
27121
+ description: Framing method configuration.
27122
+ oneOf:
27123
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
27124
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
27125
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
27126
+ ObservabilityPipelineSocketDestinationFramingBytes:
27127
+ description: Event data is not delimited at all.
27128
+ properties:
27129
+ method:
27130
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
27131
+ required:
27132
+ - method
27133
+ type: object
27134
+ ObservabilityPipelineSocketDestinationFramingBytesMethod:
27135
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
27136
+ object.
27137
+ enum:
27138
+ - bytes
27139
+ example: bytes
27140
+ type: string
27141
+ x-enum-varnames:
27142
+ - BYTES
27143
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
27144
+ description: Each log event is separated using the specified delimiter character.
27145
+ properties:
27146
+ delimiter:
27147
+ description: A single ASCII character used as a delimiter.
27148
+ example: '|'
27149
+ maxLength: 1
27150
+ minLength: 1
27151
+ type: string
27152
+ method:
27153
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
27154
+ required:
27155
+ - method
27156
+ - delimiter
27157
+ type: object
27158
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
27159
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
27160
+ object.
27161
+ enum:
27162
+ - character_delimited
27163
+ example: character_delimited
27164
+ type: string
27165
+ x-enum-varnames:
27166
+ - CHARACTER_DELIMITED
27167
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
27168
+ description: Each log event is delimited by a newline character.
27169
+ properties:
27170
+ method:
27171
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
27172
+ required:
27173
+ - method
27174
+ type: object
27175
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
27176
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
27177
+ object.
27178
+ enum:
27179
+ - newline_delimited
27180
+ example: newline_delimited
27181
+ type: string
27182
+ x-enum-varnames:
27183
+ - NEWLINE_DELIMITED
27184
+ ObservabilityPipelineSocketDestinationMode:
27185
+ description: Protocol used to send logs.
27186
+ enum:
27187
+ - tcp
27188
+ - udp
27189
+ example: tcp
27190
+ type: string
27191
+ x-enum-varnames:
27192
+ - TCP
27193
+ - UDP
27194
+ ObservabilityPipelineSocketDestinationType:
27195
+ default: socket
27196
+ description: The destination type. The value should always be `socket`.
27197
+ enum:
27198
+ - socket
27199
+ example: socket
27200
+ type: string
27201
+ x-enum-varnames:
27202
+ - SOCKET
27203
+ ObservabilityPipelineSocketSource:
27204
+ description: 'The `socket` source ingests logs over TCP or UDP.
27205
+
27206
+ '
27207
+ properties:
27208
+ framing:
27209
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
27210
+ id:
27211
+ description: The unique identifier for this component. Used to reference
27212
+ this component in other parts of the pipeline (e.g., as input to downstream
27213
+ components).
27214
+ example: socket-source
27215
+ type: string
27216
+ mode:
27217
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
27218
+ tls:
27219
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27220
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27221
+ type:
27222
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
27223
+ required:
27224
+ - id
27225
+ - type
27226
+ - mode
27227
+ - framing
27228
+ type: object
27229
+ ObservabilityPipelineSocketSourceFraming:
27230
+ description: Framing method configuration for the socket source.
27231
+ oneOf:
27232
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
27233
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
27234
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
27235
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
27236
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
27237
+ ObservabilityPipelineSocketSourceFramingBytes:
27238
+ description: Byte frames are passed through as-is according to the underlying
27239
+ I/O boundaries (for example, split between messages or stream segments).
27240
+ properties:
27241
+ method:
27242
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
27243
+ required:
27244
+ - method
27245
+ type: object
27246
+ ObservabilityPipelineSocketSourceFramingBytesMethod:
27247
+ description: Byte frames are passed through as-is according to the underlying
27248
+ I/O boundaries (for example, split between messages or stream segments).
27249
+ enum:
27250
+ - bytes
27251
+ example: bytes
27252
+ type: string
27253
+ x-enum-varnames:
27254
+ - BYTES
27255
+ ObservabilityPipelineSocketSourceFramingCharacterDelimited:
27256
+ description: Byte frames which are delimited by a chosen character.
27257
+ properties:
27258
+ delimiter:
27259
+ description: A single ASCII character used to delimit events.
27260
+ example: '|'
27261
+ maxLength: 1
27262
+ minLength: 1
27263
+ type: string
27264
+ method:
27265
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
27266
+ required:
27267
+ - method
27268
+ - delimiter
27269
+ type: object
27270
+ ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
27271
+ description: Byte frames which are delimited by a chosen character.
27272
+ enum:
27273
+ - character_delimited
27274
+ example: character_delimited
27275
+ type: string
27276
+ x-enum-varnames:
27277
+ - CHARACTER_DELIMITED
27278
+ ObservabilityPipelineSocketSourceFramingChunkedGelf:
27279
+ description: Byte frames which are chunked GELF messages.
27280
+ properties:
27281
+ method:
27282
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
27283
+ required:
27284
+ - method
27285
+ type: object
27286
+ ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
27287
+ description: Byte frames which are chunked GELF messages.
27288
+ enum:
27289
+ - chunked_gelf
27290
+ example: chunked_gelf
27291
+ type: string
27292
+ x-enum-varnames:
27293
+ - CHUNKED_GELF
27294
+ ObservabilityPipelineSocketSourceFramingNewlineDelimited:
27295
+ description: Byte frames which are delimited by a newline character.
27296
+ properties:
27297
+ method:
27298
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
27299
+ required:
27300
+ - method
27301
+ type: object
27302
+ ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
27303
+ description: Byte frames which are delimited by a newline character.
27304
+ enum:
27305
+ - newline_delimited
27306
+ example: newline_delimited
27307
+ type: string
27308
+ x-enum-varnames:
27309
+ - NEWLINE_DELIMITED
27310
+ ObservabilityPipelineSocketSourceFramingOctetCounting:
27311
+ description: Byte frames according to the octet counting format as per RFC6587.
27312
+ properties:
27313
+ method:
27314
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
27315
+ required:
27316
+ - method
27317
+ type: object
27318
+ ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
27319
+ description: Byte frames according to the octet counting format as per RFC6587.
27320
+ enum:
27321
+ - octet_counting
27322
+ example: octet_counting
27323
+ type: string
27324
+ x-enum-varnames:
27325
+ - OCTET_COUNTING
27326
+ ObservabilityPipelineSocketSourceMode:
27327
+ description: Protocol used to receive logs.
27328
+ enum:
27329
+ - tcp
27330
+ - udp
27331
+ example: tcp
27332
+ type: string
27333
+ x-enum-varnames:
27334
+ - TCP
27335
+ - UDP
27336
+ ObservabilityPipelineSocketSourceType:
27337
+ default: socket
27338
+ description: The source type. The value should always be `socket`.
27339
+ enum:
27340
+ - socket
27341
+ example: socket
27342
+ type: string
27343
+ x-enum-varnames:
27344
+ - SOCKET
27071
27345
ObservabilityPipelineSpec:
27072
27346
description: Input schema representing an observability pipeline configuration.
27073
27347
Used in create and validate requests.
0 commit comments