Kafka

The Kafka Connection allows the Intelligence Hub to connect to Apache Kafka brokers for reading (input) and writing (output) of messages. Below are details on the connection, input, and output settings and supported features.

Connection Settings

SettingDescription
Broker URIsOne or more Kafka broker URIs to connect to (e.g., broker1:9092,broker2:9092). The connection uses the first broker in the list that successfully connects.
Security TypeSecurity type used for the Kafka client connection. Plaintext: no security. SSL: enables TLS or mTLS.
Truststore CA CertificateThe broker’s CA certificate imported into the certificate store. Required for standard TLS and mTLS. Only available when Security Type is SSL.
Keystore Client KeypairThe client certificate keypair imported into the certificate store. Required only for mTLS. Only available when Security Type is SSL.

Input Settings

Kafka inputs subscribe to topics and consume messages. The following settings are available:

SettingDescription
TopicThe topic to subscribe to.
GroupThe consumer group ID to join.
Initial OffsetWhere to start consuming if no offset exists (e.g., earliest, latest).
Key FormatThe expected format for the message key (Any, JSON, String, Binary). See options below.
Value FormatThe expected format for the message value (Any, JSON, String, Binary). See options below.
Max MessagesMaximum number of records per read.
Include MetadataInclude metadata such as topic, partition, offset, timestamp, headers, key.

Key/Value Format Options

TypeDescription
AnyThe payload can be JSON, String, or Binary
JSONThe payload is deserialized as JSON. Non-JSON payloads are ignored.
String (UTF-8)The payload is treated as a string.
BinaryThe payload is treated as a byte array.

Output Settings

Kafka outputs publish messages to topics. The following settings are available:

SettingDescription
TopicThe topic to publish messages to.
KeyThe key to use for the message.
ValueThe value to publish (payload).