Skip to content

Source Connectors

In this lesson you will learn source connectors in Apache Kafka, why it matters within kafka connect, and how to use it correctly with clear, copy-ready examples.

Source Connectors Overview

Source Connectors is a building block you will reach for often in Apache Kafka. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn source connectors properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real Apache Kafka projects.

// 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.

Source 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 Source Connectors example and grow it only as needed.
  • Keep configuration explicit so Source Connectors behaves the same in every environment.
  • Name things clearly so teammates understand your Source Connectors at a glance.
  • Add tests around Source Connectors early to lock in expected behaviour.

Apache Kafka Cheatsheet

Handy KafkaJS reference related to source 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 Source Connectors Works in Apache Kafka

Source 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 Source Connectors

In production, source 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

  • Copying source connectors snippets without understanding what each line does.
  • Skipping error handling and edge cases when wiring up source connectors.
  • Leaving source connectors untested, so regressions slip into production.
  • Over-engineering source connectors before you actually need the extra flexibility.

Key Takeaways

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

Pro Tip

Pair source connectors with automated tests from day one. It is far cheaper to catch Apache Kafka regressions in CI than in production.