Class ObservabilityPipelineKafkaDestination

The kafka destination sends logs to Apache Kafka topics.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineKafkaDestination

Constructors

constructor

Properties

additionalProperties? compression? encoding headersKey? id inputs keyField? librdkafkaOptions? messageTimeoutMs? rateLimitDurationSecs? rateLimitNum? sasl? socketTimeoutMs? tls? topic 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

Optional compression

compression?: ObservabilityPipelineKafkaDestinationCompression

Compression codec for Kafka messages.

encoding

encoding: ObservabilityPipelineKafkaDestinationEncoding

Encoding format for log events.

Optional headersKey

headersKey?: string

The field name to use for Kafka message headers.

id

id: string

The unique identifier for this component.

inputs

inputs: string[]

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

Optional keyField

keyField?: string

The field name to use as the Kafka message key.

Optional librdkafkaOptions

librdkafkaOptions?: ObservabilityPipelineKafkaLibrdkafkaOption[]

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

Optional messageTimeoutMs

messageTimeoutMs?: number

Maximum time in milliseconds to wait for message delivery confirmation.

Optional rateLimitDurationSecs

rateLimitDurationSecs?: number

Duration in seconds for the rate limit window.

Optional rateLimitNum

rateLimitNum?: number

Maximum number of messages allowed per rate limit duration.

Optional sasl

sasl?: ObservabilityPipelineKafkaSasl

Specifies the SASL mechanism for authenticating with a Kafka cluster.

Optional socketTimeoutMs

socketTimeoutMs?: number

Socket timeout in milliseconds for network requests.

Optional tls

tls?: ObservabilityPipelineTls

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

topic

topic: string

The Kafka topic name to publish logs to.

type

type: ObservabilityPipelineKafkaDestinationType

The destination type. The value should always be kafka.

Settings

Member Visibility

Theme

Generated using TypeDoc