Class ObservabilityPipelineWebsocketSource

The websocket source ingests logs from a WebSocket server using the ws:// or wss:// protocol.

Supported pipeline types: logs.

Hierarchy

  • ObservabilityPipelineWebsocketSource

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Authentication strategy for the WebSocket source connection.

customKey?: string

Name of the environment variable or secret that holds the custom authorization header value. Used when auth_strategy is custom.

The decoding format used to interpret incoming logs.

id: string

The unique identifier for this component.

passwordKey?: string

Name of the environment variable or secret that holds the password. Used when auth_strategy is basic.

TLS configuration for the WebSocket source. Use enabled for standard wss:// connections, or with_client_cert to present a client certificate for mutual TLS.

tokenKey?: string

Name of the environment variable or secret that holds the bearer token. Used when auth_strategy is bearer.

The source type. The value should always be websocket.

uriKey?: string

Name of the environment variable or secret that holds the WebSocket server URI (ws:// or wss://).

usernameKey?: string

Name of the environment variable or secret that holds the username. Used when auth_strategy is basic.

Generated using TypeDoc