Class ObservabilityPipelineKafkaSource

The kafka source ingests data from Apache Kafka topics.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineKafkaSource

Constructors

constructor

Properties

additionalProperties? groupId id librdkafkaOptions? sasl? tls? topics type

Constructors

constructor

Properties

Optional additionalProperties

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

groupId

groupId: string

Consumer group ID used by the Kafka client.

id

id: string

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

Optional librdkafkaOptions

librdkafkaOptions?: ObservabilityPipelineKafkaLibrdkafkaOption[]

Optional list of advanced Kafka client configuration options, defined as key-value pairs.

Optional sasl

sasl?: ObservabilityPipelineKafkaSasl

Specifies the SASL mechanism for authenticating with a Kafka cluster.

Optional tls

tls?: ObservabilityPipelineTls

Configuration for enabling TLS encryption between the pipeline component and external services.

topics

topics: string[]

A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified.

type

type: ObservabilityPipelineKafkaSourceType

The source type. The value should always be kafka.

Settings

Member Visibility

Theme

Generated using TypeDoc