@@ -25104,6 +25104,7 @@ components:
25104
25104
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
25105
25105
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
25106
25106
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
25107
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
25107
25108
ObservabilityPipelineConfigProcessorItem:
25108
25109
description: A processor for the pipeline.
25109
25110
oneOf:
@@ -25141,6 +25142,7 @@ components:
25141
25142
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
25142
25143
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
25143
25144
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
25145
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
25144
25146
ObservabilityPipelineData:
25145
25147
description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
25146
25148
properties:
@@ -27424,6 +27426,278 @@ components:
27424
27426
type: string
27425
27427
x-enum-varnames:
27426
27428
- SENTINEL_ONE
27429
+ ObservabilityPipelineSocketDestination:
27430
+ description: 'The `socket` destination sends logs over TCP or UDP to a remote
27431
+ server.
27432
+
27433
+ '
27434
+ properties:
27435
+ encoding:
27436
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
27437
+ framing:
27438
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
27439
+ id:
27440
+ description: The unique identifier for this component.
27441
+ example: socket-destination
27442
+ type: string
27443
+ inputs:
27444
+ description: A list of component IDs whose output is used as the `input`
27445
+ for this component.
27446
+ example:
27447
+ - filter-processor
27448
+ items:
27449
+ type: string
27450
+ type: array
27451
+ mode:
27452
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
27453
+ tls:
27454
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27455
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27456
+ type:
27457
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
27458
+ required:
27459
+ - id
27460
+ - type
27461
+ - inputs
27462
+ - encoding
27463
+ - framing
27464
+ - mode
27465
+ type: object
27466
+ ObservabilityPipelineSocketDestinationEncoding:
27467
+ description: Encoding format for log events.
27468
+ enum:
27469
+ - json
27470
+ - raw_message
27471
+ example: json
27472
+ type: string
27473
+ x-enum-varnames:
27474
+ - JSON
27475
+ - RAW_MESSAGE
27476
+ ObservabilityPipelineSocketDestinationFraming:
27477
+ description: Framing method configuration.
27478
+ oneOf:
27479
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
27480
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
27481
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
27482
+ ObservabilityPipelineSocketDestinationFramingBytes:
27483
+ description: Event data is not delimited at all.
27484
+ properties:
27485
+ method:
27486
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
27487
+ required:
27488
+ - method
27489
+ type: object
27490
+ ObservabilityPipelineSocketDestinationFramingBytesMethod:
27491
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
27492
+ object.
27493
+ enum:
27494
+ - bytes
27495
+ example: bytes
27496
+ type: string
27497
+ x-enum-varnames:
27498
+ - BYTES
27499
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
27500
+ description: Each log event is separated using the specified delimiter character.
27501
+ properties:
27502
+ delimiter:
27503
+ description: A single ASCII character used as a delimiter.
27504
+ example: '|'
27505
+ maxLength: 1
27506
+ minLength: 1
27507
+ type: string
27508
+ method:
27509
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
27510
+ required:
27511
+ - method
27512
+ - delimiter
27513
+ type: object
27514
+ ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
27515
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
27516
+ object.
27517
+ enum:
27518
+ - character_delimited
27519
+ example: character_delimited
27520
+ type: string
27521
+ x-enum-varnames:
27522
+ - CHARACTER_DELIMITED
27523
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
27524
+ description: Each log event is delimited by a newline character.
27525
+ properties:
27526
+ method:
27527
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
27528
+ required:
27529
+ - method
27530
+ type: object
27531
+ ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
27532
+ description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
27533
+ object.
27534
+ enum:
27535
+ - newline_delimited
27536
+ example: newline_delimited
27537
+ type: string
27538
+ x-enum-varnames:
27539
+ - NEWLINE_DELIMITED
27540
+ ObservabilityPipelineSocketDestinationMode:
27541
+ description: Protocol used to send logs.
27542
+ enum:
27543
+ - tcp
27544
+ - udp
27545
+ example: tcp
27546
+ type: string
27547
+ x-enum-varnames:
27548
+ - TCP
27549
+ - UDP
27550
+ ObservabilityPipelineSocketDestinationType:
27551
+ default: socket
27552
+ description: The destination type. The value should always be `socket`.
27553
+ enum:
27554
+ - socket
27555
+ example: socket
27556
+ type: string
27557
+ x-enum-varnames:
27558
+ - SOCKET
27559
+ ObservabilityPipelineSocketSource:
27560
+ description: 'The `socket` source ingests logs over TCP or UDP.
27561
+
27562
+ '
27563
+ properties:
27564
+ framing:
27565
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
27566
+ id:
27567
+ description: The unique identifier for this component. Used to reference
27568
+ this component in other parts of the pipeline (e.g., as input to downstream
27569
+ components).
27570
+ example: socket-source
27571
+ type: string
27572
+ mode:
27573
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
27574
+ tls:
27575
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
27576
+ description: TLS configuration. Relevant only when `mode` is `tcp`.
27577
+ type:
27578
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
27579
+ required:
27580
+ - id
27581
+ - type
27582
+ - mode
27583
+ - framing
27584
+ type: object
27585
+ ObservabilityPipelineSocketSourceFraming:
27586
+ description: Framing method configuration for the socket source.
27587
+ oneOf:
27588
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
27589
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
27590
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
27591
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
27592
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
27593
+ ObservabilityPipelineSocketSourceFramingBytes:
27594
+ description: Byte frames are passed through as-is according to the underlying
27595
+ I/O boundaries (for example, split between messages or stream segments).
27596
+ properties:
27597
+ method:
27598
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
27599
+ required:
27600
+ - method
27601
+ type: object
27602
+ ObservabilityPipelineSocketSourceFramingBytesMethod:
27603
+ description: Byte frames are passed through as-is according to the underlying
27604
+ I/O boundaries (for example, split between messages or stream segments).
27605
+ enum:
27606
+ - bytes
27607
+ example: bytes
27608
+ type: string
27609
+ x-enum-varnames:
27610
+ - BYTES
27611
+ ObservabilityPipelineSocketSourceFramingCharacterDelimited:
27612
+ description: Byte frames which are delimited by a chosen character.
27613
+ properties:
27614
+ delimiter:
27615
+ description: A single ASCII character used to delimit events.
27616
+ example: '|'
27617
+ maxLength: 1
27618
+ minLength: 1
27619
+ type: string
27620
+ method:
27621
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
27622
+ required:
27623
+ - method
27624
+ - delimiter
27625
+ type: object
27626
+ ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
27627
+ description: Byte frames which are delimited by a chosen character.
27628
+ enum:
27629
+ - character_delimited
27630
+ example: character_delimited
27631
+ type: string
27632
+ x-enum-varnames:
27633
+ - CHARACTER_DELIMITED
27634
+ ObservabilityPipelineSocketSourceFramingChunkedGelf:
27635
+ description: Byte frames which are chunked GELF messages.
27636
+ properties:
27637
+ method:
27638
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
27639
+ required:
27640
+ - method
27641
+ type: object
27642
+ ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
27643
+ description: Byte frames which are chunked GELF messages.
27644
+ enum:
27645
+ - chunked_gelf
27646
+ example: chunked_gelf
27647
+ type: string
27648
+ x-enum-varnames:
27649
+ - CHUNKED_GELF
27650
+ ObservabilityPipelineSocketSourceFramingNewlineDelimited:
27651
+ description: Byte frames which are delimited by a newline character.
27652
+ properties:
27653
+ method:
27654
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
27655
+ required:
27656
+ - method
27657
+ type: object
27658
+ ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
27659
+ description: Byte frames which are delimited by a newline character.
27660
+ enum:
27661
+ - newline_delimited
27662
+ example: newline_delimited
27663
+ type: string
27664
+ x-enum-varnames:
27665
+ - NEWLINE_DELIMITED
27666
+ ObservabilityPipelineSocketSourceFramingOctetCounting:
27667
+ description: Byte frames according to the octet counting format as per RFC6587.
27668
+ properties:
27669
+ method:
27670
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
27671
+ required:
27672
+ - method
27673
+ type: object
27674
+ ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
27675
+ description: Byte frames according to the octet counting format as per RFC6587.
27676
+ enum:
27677
+ - octet_counting
27678
+ example: octet_counting
27679
+ type: string
27680
+ x-enum-varnames:
27681
+ - OCTET_COUNTING
27682
+ ObservabilityPipelineSocketSourceMode:
27683
+ description: Protocol used to receive logs.
27684
+ enum:
27685
+ - tcp
27686
+ - udp
27687
+ example: tcp
27688
+ type: string
27689
+ x-enum-varnames:
27690
+ - TCP
27691
+ - UDP
27692
+ ObservabilityPipelineSocketSourceType:
27693
+ default: socket
27694
+ description: The source type. The value should always be `socket`.
27695
+ enum:
27696
+ - socket
27697
+ example: socket
27698
+ type: string
27699
+ x-enum-varnames:
27700
+ - SOCKET
27427
27701
ObservabilityPipelineSpec:
27428
27702
description: Input schema representing an observability pipeline configuration.
27429
27703
Used in create and validate requests.
0 commit comments