@@ -24954,6 +24954,7 @@ components:
24954
24954
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
24955
24955
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
24956
24956
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
24957
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
24957
24958
ObservabilityPipelineConfigProcessorItem:
24958
24959
description: A processor for the pipeline.
24959
24960
oneOf:
@@ -24991,6 +24992,7 @@ components:
24991
24992
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
24992
24993
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
24993
24994
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
24995
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
24994
24996
ObservabilityPipelineData:
24995
24997
description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
24996
24998
properties:
@@ -27274,6 +27276,278 @@ components:
27274
27276
type: string
27275
27277
x-enum-varnames:
27276
27278
- SENTINEL_ONE
27279
+ ObservabilityPipelineSocketDestination:
27280
+ description: 'The `socket` destination sends logs over TCP or UDP to a remote
27281
+ server.
27282
+
27283
+ '
27284
+ properties:
27285
+ encoding:
27286
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
27287
+ framing:
27288
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
27289
+ id:
27290
+ description: The unique identifier for this component.
27291
+ example: socket-destination
27292
+ type: string
27293
+ inputs:
27294
+ description: A list of component IDs whose output is used as the `input`
27295
+ for this component.
27296
+ example:
27297
+ - filter-processor
27298
+ items:
27299
+ type: string
27300
+ type: array
27301
+ mode:
27302
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
27303
+ tls:
27304
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27305
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27306
+ type:
27307
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
27308
+ required:
27309
+ - id
27310
+ - type
27311
+ - inputs
27312
+ - encoding
27313
+ - framing
27314
+ - mode
27315
+ type: object
27316
+ ObservabilityPipelineSocketDestinationEncoding:
27317
+ description: Encoding format for log events.
27318
+ enum:
27319
+ - json
27320
+ - raw_message
27321
+ example: json
27322
+ type: string
27323
+ x-enum-varnames:
27324
+ - JSON
27325
+ - RAW_MESSAGE
27326
+ ObservabilityPipelineSocketDestinationFraming:
27327
+ description: Framing method configuration.
27328
+ oneOf:
27329
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
27330
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
27331
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
27332
+ ObservabilityPipelineSocketDestinationFramingBytes:
27333
+ description: Event data is not delimited at all.
27334
+ properties:
27335
+ method:
27336
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
27337
+ required:
27338
+ - method
27339
+ type: object
27340
+ ObservabilityPipelineSocketDestinationFramingBytesMethod:
27341
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
27342
+ object.
27343
+ enum:
27344
+ - bytes
27345
+ example: bytes
27346
+ type: string
27347
+ x-enum-varnames:
27348
+ - BYTES
27349
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
27350
+ description: Each log event is separated using the specified delimiter character.
27351
+ properties:
27352
+ delimiter:
27353
+ description: A single ASCII character used as a delimiter.
27354
+ example: '|'
27355
+ maxLength: 1
27356
+ minLength: 1
27357
+ type: string
27358
+ method:
27359
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
27360
+ required:
27361
+ - method
27362
+ - delimiter
27363
+ type: object
27364
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
27365
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
27366
+ object.
27367
+ enum:
27368
+ - character_delimited
27369
+ example: character_delimited
27370
+ type: string
27371
+ x-enum-varnames:
27372
+ - CHARACTER_DELIMITED
27373
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
27374
+ description: Each log event is delimited by a newline character.
27375
+ properties:
27376
+ method:
27377
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
27378
+ required:
27379
+ - method
27380
+ type: object
27381
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
27382
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
27383
+ object.
27384
+ enum:
27385
+ - newline_delimited
27386
+ example: newline_delimited
27387
+ type: string
27388
+ x-enum-varnames:
27389
+ - NEWLINE_DELIMITED
27390
+ ObservabilityPipelineSocketDestinationMode:
27391
+ description: Protocol used to send logs.
27392
+ enum:
27393
+ - tcp
27394
+ - udp
27395
+ example: tcp
27396
+ type: string
27397
+ x-enum-varnames:
27398
+ - TCP
27399
+ - UDP
27400
+ ObservabilityPipelineSocketDestinationType:
27401
+ default: socket
27402
+ description: The destination type. The value should always be `socket`.
27403
+ enum:
27404
+ - socket
27405
+ example: socket
27406
+ type: string
27407
+ x-enum-varnames:
27408
+ - SOCKET
27409
+ ObservabilityPipelineSocketSource:
27410
+ description: 'The `socket` source ingests logs over TCP or UDP.
27411
+
27412
+ '
27413
+ properties:
27414
+ framing:
27415
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
27416
+ id:
27417
+ description: The unique identifier for this component. Used to reference
27418
+ this component in other parts of the pipeline (e.g., as input to downstream
27419
+ components).
27420
+ example: socket-source
27421
+ type: string
27422
+ mode:
27423
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
27424
+ tls:
27425
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27426
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27427
+ type:
27428
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
27429
+ required:
27430
+ - id
27431
+ - type
27432
+ - mode
27433
+ - framing
27434
+ type: object
27435
+ ObservabilityPipelineSocketSourceFraming:
27436
+ description: Framing method configuration for the socket source.
27437
+ oneOf:
27438
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
27439
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
27440
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
27441
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
27442
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
27443
+ ObservabilityPipelineSocketSourceFramingBytes:
27444
+ description: Byte frames are passed through as-is according to the underlying
27445
+ I/O boundaries (for example, split between messages or stream segments).
27446
+ properties:
27447
+ method:
27448
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
27449
+ required:
27450
+ - method
27451
+ type: object
27452
+ ObservabilityPipelineSocketSourceFramingBytesMethod:
27453
+ description: Byte frames are passed through as-is according to the underlying
27454
+ I/O boundaries (for example, split between messages or stream segments).
27455
+ enum:
27456
+ - bytes
27457
+ example: bytes
27458
+ type: string
27459
+ x-enum-varnames:
27460
+ - BYTES
27461
+ ObservabilityPipelineSocketSourceFramingCharacterDelimited:
27462
+ description: Byte frames which are delimited by a chosen character.
27463
+ properties:
27464
+ delimiter:
27465
+ description: A single ASCII character used to delimit events.
27466
+ example: '|'
27467
+ maxLength: 1
27468
+ minLength: 1
27469
+ type: string
27470
+ method:
27471
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
27472
+ required:
27473
+ - method
27474
+ - delimiter
27475
+ type: object
27476
+ ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
27477
+ description: Byte frames which are delimited by a chosen character.
27478
+ enum:
27479
+ - character_delimited
27480
+ example: character_delimited
27481
+ type: string
27482
+ x-enum-varnames:
27483
+ - CHARACTER_DELIMITED
27484
+ ObservabilityPipelineSocketSourceFramingChunkedGelf:
27485
+ description: Byte frames which are chunked GELF messages.
27486
+ properties:
27487
+ method:
27488
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
27489
+ required:
27490
+ - method
27491
+ type: object
27492
+ ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
27493
+ description: Byte frames which are chunked GELF messages.
27494
+ enum:
27495
+ - chunked_gelf
27496
+ example: chunked_gelf
27497
+ type: string
27498
+ x-enum-varnames:
27499
+ - CHUNKED_GELF
27500
+ ObservabilityPipelineSocketSourceFramingNewlineDelimited:
27501
+ description: Byte frames which are delimited by a newline character.
27502
+ properties:
27503
+ method:
27504
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
27505
+ required:
27506
+ - method
27507
+ type: object
27508
+ ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
27509
+ description: Byte frames which are delimited by a newline character.
27510
+ enum:
27511
+ - newline_delimited
27512
+ example: newline_delimited
27513
+ type: string
27514
+ x-enum-varnames:
27515
+ - NEWLINE_DELIMITED
27516
+ ObservabilityPipelineSocketSourceFramingOctetCounting:
27517
+ description: Byte frames according to the octet counting format as per RFC6587.
27518
+ properties:
27519
+ method:
27520
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
27521
+ required:
27522
+ - method
27523
+ type: object
27524
+ ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
27525
+ description: Byte frames according to the octet counting format as per RFC6587.
27526
+ enum:
27527
+ - octet_counting
27528
+ example: octet_counting
27529
+ type: string
27530
+ x-enum-varnames:
27531
+ - OCTET_COUNTING
27532
+ ObservabilityPipelineSocketSourceMode:
27533
+ description: Protocol used to receive logs.
27534
+ enum:
27535
+ - tcp
27536
+ - udp
27537
+ example: tcp
27538
+ type: string
27539
+ x-enum-varnames:
27540
+ - TCP
27541
+ - UDP
27542
+ ObservabilityPipelineSocketSourceType:
27543
+ default: socket
27544
+ description: The source type. The value should always be `socket`.
27545
+ enum:
27546
+ - socket
27547
+ example: socket
27548
+ type: string
27549
+ x-enum-varnames:
27550
+ - SOCKET
27277
27551
ObservabilityPipelineSpec:
27278
27552
description: Input schema representing an observability pipeline configuration.
27279
27553
Used in create and validate requests.
0 commit comments