Skip to content

Manual Offset Commit

Manual Offset Commit sits at the heart of offsets in Apache Kafka. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

Manual Offset Commit Overview

Manual Offset Commit 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 manual offset commit 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.

import { Kafka } from 'kafkajs';

const kafka = new Kafka({ clientId: 'orders', brokers: ['localhost:9092'] });
const consumer = kafka.consumer({ groupId: 'order-processors' });

await consumer.connect();
await consumer.subscribe({ topic: 'orders', fromBeginning: false });

await consumer.run({
  eachMessage: async ({ topic, partition, message }) => {
    const order = JSON.parse(message.value.toString());
    console.log({ partition, key: message.key?.toString(), order });
  },
});

A consumer joins a group and processes messages from the partitions it is assigned.

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

Apache Kafka Cheatsheet

Handy KafkaJS reference related to manual offset commit.

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 Manual Offset Commit Works in Apache Kafka

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

A consumer joins a group and processes messages from the partitions it is assigned.

  • 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 Manual Offset Commit

In production, manual offset commit 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 manual offset commit.
  • Leaving manual offset commit untested, so regressions slip into production.
  • Over-engineering manual offset commit before you actually need the extra flexibility.
  • Ignoring documentation, which makes manual offset commit hard for the next developer to change.

Key Takeaways

  • Manual Offset Commit is a core part of working effectively with Apache Kafka.
  • Start small and keep manual offset commit focused on a single responsibility.
  • Apply consistent patterns so manual offset commit scales across your project.
  • Test and document manual offset commit to keep it maintainable over time.

Pro Tip

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