Compensating Events

Compensating Events Overview

Compensating Events 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 compensating events focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

// each service reacts to events and emits new ones
await consumer.subscribe({ topic: 'payment-completed' });
await consumer.run({
  eachMessage: async ({ message }) => {
    const payment = JSON.parse(message.value.toString());
    await producer.send({
      topic: 'order-confirmed',
      messages: [{ key: payment.orderId, value: JSON.stringify(payment) }],
    });
  },
});

Event-driven services stay decoupled by reacting to and emitting Kafka events.

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

Apache Kafka Cheatsheet

Handy KafkaJS reference related to compensating events.

How Compensating Events Works in Apache Kafka

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

Event-driven services stay decoupled by reacting to and emitting Kafka events.

• 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 Compensating Events

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

Common Mistakes

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

Key Takeaways

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