@@ -24267,6 +24267,7 @@ components:
2426724267 - $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
2426824268 - $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
2426924269 - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
24270+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
2427024271 ObservabilityPipelineConfigProcessorItem:
2427124272 description: A processor for the pipeline.
2427224273 oneOf:
@@ -24304,6 +24305,7 @@ components:
2430424305 - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
2430524306 - $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
2430624307 - $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
24308+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
2430724309 ObservabilityPipelineData:
2430824310 description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
2430924311 properties:
@@ -26587,6 +26589,278 @@ components:
2658726589 type: string
2658826590 x-enum-varnames:
2658926591 - SENTINEL_ONE
26592+ ObservabilityPipelineSocketDestination:
26593+ description: 'The `socket` destination sends logs over TCP or UDP to a remote
26594+ server.
26595+
26596+ '
26597+ properties:
26598+ encoding:
26599+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
26600+ framing:
26601+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
26602+ id:
26603+ description: The unique identifier for this component.
26604+ example: socket-destination
26605+ type: string
26606+ inputs:
26607+ description: A list of component IDs whose output is used as the `input`
26608+ for this component.
26609+ example:
26610+ - filter-processor
26611+ items:
26612+ type: string
26613+ type: array
26614+ mode:
26615+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
26616+ tls:
26617+ $ref: '#/components/schemas/ObservabilityPipelineTls'
26618+ description: TLS configuration. Relevant only when `mode` is `tcp`.
26619+ type:
26620+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
26621+ required:
26622+ - id
26623+ - type
26624+ - inputs
26625+ - encoding
26626+ - framing
26627+ - mode
26628+ type: object
26629+ ObservabilityPipelineSocketDestinationEncoding:
26630+ description: Encoding format for log events.
26631+ enum:
26632+ - json
26633+ - raw_message
26634+ example: json
26635+ type: string
26636+ x-enum-varnames:
26637+ - JSON
26638+ - RAW_MESSAGE
26639+ ObservabilityPipelineSocketDestinationFraming:
26640+ description: Framing method configuration.
26641+ oneOf:
26642+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
26643+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
26644+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
26645+ ObservabilityPipelineSocketDestinationFramingBytes:
26646+ description: Event data is not delimited at all.
26647+ properties:
26648+ method:
26649+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
26650+ required:
26651+ - method
26652+ type: object
26653+ ObservabilityPipelineSocketDestinationFramingBytesMethod:
26654+ description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
26655+ object.
26656+ enum:
26657+ - bytes
26658+ example: bytes
26659+ type: string
26660+ x-enum-varnames:
26661+ - BYTES
26662+ ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
26663+ description: Each log event is separated using the specified delimiter character.
26664+ properties:
26665+ delimiter:
26666+ description: A single ASCII character used as a delimiter.
26667+ example: '|'
26668+ maxLength: 1
26669+ minLength: 1
26670+ type: string
26671+ method:
26672+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
26673+ required:
26674+ - method
26675+ - delimiter
26676+ type: object
26677+ ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
26678+ description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
26679+ object.
26680+ enum:
26681+ - character_delimited
26682+ example: character_delimited
26683+ type: string
26684+ x-enum-varnames:
26685+ - CHARACTER_DELIMITED
26686+ ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
26687+ description: Each log event is delimited by a newline character.
26688+ properties:
26689+ method:
26690+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
26691+ required:
26692+ - method
26693+ type: object
26694+ ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
26695+ description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
26696+ object.
26697+ enum:
26698+ - newline_delimited
26699+ example: newline_delimited
26700+ type: string
26701+ x-enum-varnames:
26702+ - NEWLINE_DELIMITED
26703+ ObservabilityPipelineSocketDestinationMode:
26704+ description: Protocol used to send logs.
26705+ enum:
26706+ - tcp
26707+ - udp
26708+ example: tcp
26709+ type: string
26710+ x-enum-varnames:
26711+ - TCP
26712+ - UDP
26713+ ObservabilityPipelineSocketDestinationType:
26714+ default: socket
26715+ description: The destination type. The value should always be `socket`.
26716+ enum:
26717+ - socket
26718+ example: socket
26719+ type: string
26720+ x-enum-varnames:
26721+ - SOCKET
26722+ ObservabilityPipelineSocketSource:
26723+ description: 'The `socket` source ingests logs over TCP or UDP.
26724+
26725+ '
26726+ properties:
26727+ framing:
26728+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
26729+ id:
26730+ description: The unique identifier for this component. Used to reference
26731+ this component in other parts of the pipeline (e.g., as input to downstream
26732+ components).
26733+ example: socket-source
26734+ type: string
26735+ mode:
26736+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
26737+ tls:
26738+ $ref: '#/components/schemas/ObservabilityPipelineTls'
26739+ description: TLS configuration. Relevant only when `mode` is `tcp`.
26740+ type:
26741+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
26742+ required:
26743+ - id
26744+ - type
26745+ - mode
26746+ - framing
26747+ type: object
26748+ ObservabilityPipelineSocketSourceFraming:
26749+ description: Framing method configuration for the socket source.
26750+ oneOf:
26751+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
26752+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
26753+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
26754+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
26755+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
26756+ ObservabilityPipelineSocketSourceFramingBytes:
26757+ description: Byte frames are passed through as-is according to the underlying
26758+ I/O boundaries (for example, split between messages or stream segments).
26759+ properties:
26760+ method:
26761+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
26762+ required:
26763+ - method
26764+ type: object
26765+ ObservabilityPipelineSocketSourceFramingBytesMethod:
26766+ description: Byte frames are passed through as-is according to the underlying
26767+ I/O boundaries (for example, split between messages or stream segments).
26768+ enum:
26769+ - bytes
26770+ example: bytes
26771+ type: string
26772+ x-enum-varnames:
26773+ - BYTES
26774+ ObservabilityPipelineSocketSourceFramingCharacterDelimited:
26775+ description: Byte frames which are delimited by a chosen character.
26776+ properties:
26777+ delimiter:
26778+ description: A single ASCII character used to delimit events.
26779+ example: '|'
26780+ maxLength: 1
26781+ minLength: 1
26782+ type: string
26783+ method:
26784+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
26785+ required:
26786+ - method
26787+ - delimiter
26788+ type: object
26789+ ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
26790+ description: Byte frames which are delimited by a chosen character.
26791+ enum:
26792+ - character_delimited
26793+ example: character_delimited
26794+ type: string
26795+ x-enum-varnames:
26796+ - CHARACTER_DELIMITED
26797+ ObservabilityPipelineSocketSourceFramingChunkedGelf:
26798+ description: Byte frames which are chunked GELF messages.
26799+ properties:
26800+ method:
26801+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
26802+ required:
26803+ - method
26804+ type: object
26805+ ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
26806+ description: Byte frames which are chunked GELF messages.
26807+ enum:
26808+ - chunked_gelf
26809+ example: chunked_gelf
26810+ type: string
26811+ x-enum-varnames:
26812+ - CHUNKED_GELF
26813+ ObservabilityPipelineSocketSourceFramingNewlineDelimited:
26814+ description: Byte frames which are delimited by a newline character.
26815+ properties:
26816+ method:
26817+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
26818+ required:
26819+ - method
26820+ type: object
26821+ ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
26822+ description: Byte frames which are delimited by a newline character.
26823+ enum:
26824+ - newline_delimited
26825+ example: newline_delimited
26826+ type: string
26827+ x-enum-varnames:
26828+ - NEWLINE_DELIMITED
26829+ ObservabilityPipelineSocketSourceFramingOctetCounting:
26830+ description: Byte frames according to the octet counting format as per RFC6587.
26831+ properties:
26832+ method:
26833+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
26834+ required:
26835+ - method
26836+ type: object
26837+ ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
26838+ description: Byte frames according to the octet counting format as per RFC6587.
26839+ enum:
26840+ - octet_counting
26841+ example: octet_counting
26842+ type: string
26843+ x-enum-varnames:
26844+ - OCTET_COUNTING
26845+ ObservabilityPipelineSocketSourceMode:
26846+ description: Protocol used to receive logs.
26847+ enum:
26848+ - tcp
26849+ - udp
26850+ example: tcp
26851+ type: string
26852+ x-enum-varnames:
26853+ - TCP
26854+ - UDP
26855+ ObservabilityPipelineSocketSourceType:
26856+ default: socket
26857+ description: The source type. The value should always be `socket`.
26858+ enum:
26859+ - socket
26860+ example: socket
26861+ type: string
26862+ x-enum-varnames:
26863+ - SOCKET
2659026864 ObservabilityPipelineSpec:
2659126865 description: Input schema representing an observability pipeline configuration.
2659226866 Used in create and validate requests.
0 commit comments