Sink Connectors

Sink Connectors sits at the heart of kafka connect in Apache Kafka. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

Sink Connectors Overview

Sink Connectors lets you structure Apache Kafka work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep sink connectors focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

// consume, transform, and re-produce (a simple stream stage)
await consumer.run({
  eachMessage: async ({ message }) => {
    const event = JSON.parse(message.value.toString());
    const enriched = { ...event, receivedAt: Date.now() };
    await producer.send({
      topic: 'orders-enriched',
      messages: [{ key: event.id, value: JSON.stringify(enriched) }],
    });
  },
});

Stream processing consumes from one topic, transforms events, and produces to another.

Sink Connectors Example

import { Kafka } from 'kafkajs';

const kafka = new Kafka({ clientId: 'app', brokers: ['localhost:9092'] });
const producer = kafka.producer();
const consumer = kafka.consumer({ groupId: 'group' });

Start from a minimal Sink Connectors example and grow it only as needed.
Keep configuration explicit so Sink Connectors behaves the same in every environment.
Name things clearly so teammates understand your Sink Connectors at a glance.
Add tests around Sink Connectors early to lock in expected behaviour.

Apache Kafka Cheatsheet

Handy KafkaJS reference related to sink connectors.

Task	Example	Purpose
Create client	`new Kafka({ clientId, brokers })`	Connect to the cluster
Produce	`producer.send({ topic, messages })`	Publish events
Consume	`consumer.run({ eachMessage })`	Process events
Subscribe	`consumer.subscribe({ topic })`	Choose topics to read
Group	`kafka.consumer({ groupId })`	Scale consumers
Admin	`admin.createTopics(...)`	Manage topics
Commit offset	auto-commit or `commitOffsets`	Track progress

How Sink Connectors Works in Apache Kafka

Sink Connectors builds on Kafka's log-based design, where producers append events to partitioned topics and consumer groups read them independently, tracking their own offsets.

Stream processing consumes from one topic, transforms events, and produces to another.

Topics are split into partitions for parallelism and ordering per key.
Producers choose a partition, usually by message key.
Consumer groups share partitions so work scales horizontally.
Offsets record how far each group has read.

Practical Guidance for Sink Connectors

In production, sink connectors needs attention to delivery guarantees, retries, and observability. Make handlers idempotent and monitor consumer lag closely.

Concern	Recommendation
Ordering	Key related events so they land on one partition
Reliability	Use acks=all and idempotent producers
Idempotency	Handle duplicate deliveries safely
Monitoring	Track consumer lag and error rates

Common Mistakes

Skipping error handling and edge cases when wiring up sink connectors.
Leaving sink connectors untested, so regressions slip into production.
Over-engineering sink connectors before you actually need the extra flexibility.
Ignoring documentation, which makes sink connectors hard for the next developer to change.

Key Takeaways

Sink Connectors is a core part of working effectively with Apache Kafka.
Start small and keep sink connectors focused on a single responsibility.
Apply consistent patterns so sink connectors scales across your project.
Test and document sink connectors to keep it maintainable over time.

Pro Tip

When you get stuck on sink connectors, reduce it to the smallest reproducible example first — most Apache Kafka issues become obvious once the noise is gone.