Skip to main content

​
Connector Details

NameValue
PlatformApache Kafka
Auth TypeBroker-dependent (e.g. SASL, TLS)
DirectionWrite
Target Repohttps://github.com/hotgluexyz/target-kafka

​
Target Kafka

target-kafka writes Singer streams to Kafka topics using a producer. Each stream name maps to a topic name unless you override it (see stream_topic_map). Records are sent as message payloads for that topic.

​
Config

Set at least bootstrap_servers. If your brokers require SASL, set sasl_username and sasl_password; the target picks sensible defaults for security_protocol and sasl_mechanism when those are present. Expand the table below for every option. 
{
    "bootstrap_servers": "broker1.example.com:9092,broker2.example.com:9092",
    "sasl_username": "...",
    "sasl_password": "...",
    "topic_prefix": "",
    "client_id": "target-kafka"
}

​
Configuration reference

PropertyDescriptionDefault
bootstrap_serversComma-separated host:port list for Kafka bootstrap brokers.(required)
sasl_usernameSASL username when using SASL (for example PLAIN).—
sasl_passwordSASL password paired with sasl_username. Treat as a secret.—
security_protocolPLAINTEXT, SSL, SASL_PLAINTEXT, or SASL_SSL. If omitted, the target uses SASL_SSL when sasl_username and sasl_password are set, otherwise PLAINTEXT.inferred
sasl_mechanismSASL mechanism when the protocol is SASL-based (e.g. PLAIN, SCRAM-SHA-256).PLAIN
topic_prefixString prepended to each stream name when resolving the Kafka topic.""
stream_topic_mapObject mapping stream names to topic names; entries override topic_prefix + stream name.—
client_idClient id the producer reports to the cluster.target-kafka
flush_timeoutSeconds to wait for in-flight messages when flushing on state drain or shutdown.30
extra_producer_configExtra producer settings merged into the client (librdkafka-style keys, e.g. compression.type, linger.ms).—