Class ObservabilityPipelineKafkaDestination

The kafka destination sends logs to Apache Kafka topics.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineKafkaDestination

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
bootstrapServersKey?: string

Name of the environment variable or secret that holds the Kafka bootstrap servers list.

Configuration for buffer settings on destination components.

Compression codec for Kafka messages.

Encoding format for log events.

headersKey?: string

The field name to use for Kafka message headers.

id: string

The unique identifier for this component.

inputs: string[]

A list of component IDs whose output is used as the input for this component.

keyField?: string

The field name to use as the Kafka message key.

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

messageTimeoutMs?: number

Maximum time in milliseconds to wait for message delivery confirmation.

rateLimitDurationSecs?: number

Duration in seconds for the rate limit window.

rateLimitNum?: number

Maximum number of messages allowed per rate limit duration.

Specifies the SASL mechanism for authenticating with a Kafka cluster.

socketTimeoutMs?: number

Socket timeout in milliseconds for network requests.

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

topic: string

The Kafka topic name to publish logs to.

The destination type. The value should always be kafka.

Generated using TypeDoc