Kafka Topic Config Generator

A kafka-topics.sh create command or a topic properties file, with the replication factor and min.insync.replicas checked against each other by the replication safety analyzer on this site.

Topic
Retention
Records

topic-config.sh

updates as you type

    Common mistakes

    These are the ones that fail silently. The config is accepted, nothing raises an error, and the consequence arrives later.

    1. Setting replication factor without min.insync.replicas

      RF alone decides how many copies exist, not how many must acknowledge. With min.isr at 1 an acks=all write can be acknowledged by the leader alone.

      Instead:min.insync.replicas is the setting that provides the durability.

    2. Setting min.insync.replicas equal to the replication factor

      One broker down then stops all writes to that topic.

      Instead:min.isr = RF - 1.

    3. Choosing cleanup.policy=compact for an event stream

      Compaction keeps the latest value per key and discards the history, which for an event log is silent data loss.

      Instead:compact for state, delete for events, and compact,delete only when you mean both.

    The two numbers that decide whether the topic stays writable

    replication.factor and min.insync.replicas are usually set at the same time and are almost never thought about together, which is where the outage comes from.

    min.insync.replicas is what makes acks=all mean anything

    acks=all does not wait for every replica, it waits for the in-sync ones, and min.insync.replicas is how many that has to be. With it at 1, acks=all waits for the leader alone and provides no more durability than acks=1, which makes a carefully configured producer pointless. It is a topic setting rather than a producer setting, so the durability of a write is decided partly by someone who may not have written the producer.

    Setting it equal to the replication factor is the classic outage

    replication.factor=3 with min.insync.replicas=3 requires every replica to be in sync for a write to succeed, so the topic stops accepting acks=all writes the moment one broker goes down. That includes a routine rolling restart, which means the config looks safe in review and takes the topic offline on the next upgrade. The pairing that works is 3 and 2: it survives one broker being unavailable, and it still refuses a write when two are.

    Compaction is a different shape of retention

    cleanup.policy=compact keeps the most recent record per key indefinitely, so the size depends on the number of distinct keys rather than on time, and time-based disk estimates do not apply. Every record needs a key, since a null key on a compacted topic is rejected. A delete is a tombstone, a record with a null value, and it survives for delete.retention.ms so consumers get a chance to observe it before it disappears. This generator omits retention.ms entirely on a compact-only topic, because emitting it implies a time bound that does not exist.

    max.message.bytes is three settings, not one

    Raising the topic limit is necessary and not sufficient. The producer's max.request.size has to be at least as large or it rejects the record before sending it, and the consumer's max.partition.fetch.bytes has to be too or it cannot fetch what was written. Changing one produces an error that points at a different component from the one that needs changing, which is why this is worth stating rather than leaving to be discovered.

    What this cannot see

    It does not know your broker defaults, so it cannot tell you which of these settings is already the value you want cluster-wide and therefore does not need a topic override. It also does not know your throughput, which is what decides retention.bytes: the disk and retention calculator on this site produces that number, and remember that the setting is per partition. Partitions and replication factor are arguments to topic creation rather than topic configs, which is why they appear in the command form and not in the properties output.

    More kafka tools

    Kafka Confluent Wire Format Decoder The five junk bytes in front of your payload Kafka Key to Partition Mapper Which partition does this key land on? Kafka Topic Name Validator Legal, risky, or 249 characters too long? Kafka Replication Safety Checker How many brokers can you lose Kafka Producer Config Linter Will it start, and will it lose a record? Kafka Message Payload Decoder The first five bytes are usually not data Kafka Connect Source Connector Generator tasks.max is a ceiling, not a count Kafka Connect Sink Connector Generator A dead letter queue with no context headers is a pile of records Kafka Connect SMT Chain Builder The order is the transforms list Kafka MirrorMaker 2 Config Generator It renames every topic by default Kafka Partition Reassignment Generator The throttle is not optional Strimzi Kafka Resource Generator Without the cluster label, nothing happens Kafka mTLS Config Generator The certificate is the identity Kafka Schema Registry Config Generator The compatibility direction is your deployment order Kafka Exactly-Once Config Generator Half of it is worse than none Kafka Broker and KRaft Config Generator The internal topics that break a one-broker cluster Kafka Quota Generator Byte rates are per broker, not per cluster Kafka Streams Config Generator application.id is four things at once Kafka Connect Worker Config Generator Security three times, or the tasks fail Kafka Retention and Unit Converter log.retention.hours does not take milliseconds Kafka Timestamp Converter Two sentinels and two meanings Kafka .properties to YAML Converter Dotted keys stay flat Kafka Streams Internal Topic Predictor Create them before Streams does Kafka ACL Generator The grant you forgot is on another resource type Kafka client.properties Generator The file every CLI tool asks for Kafka Producer Config Generator No password field, on purpose Kafka Consumer Config Generator The commit mode decides the semantics Kafka Disk and Retention Calculator retention.bytes is per partition Kafka Partition Count Calculator The number you can never reduce Kafka Cluster Sizing Calculator The traffic no client metric shows Kafka Consumer Lag Catch-Up Calculator Whether it ever clears, not just when Kafka Producer Batching Calculator linger.ms=0 still batches Kafka Segment and Index Sizing Why retention.ms is a lower bound Kafka Rebalance Duration Estimator What a rolling restart really costs Kafka Cost Estimator Your rates, so nothing goes stale Kafka Config Explorer by Version The answer depends on the release Kafka Default Config Reference What moved under a config you never edited Kafka OAuth Bearer Token Decoder Will Kafka accept it, and can it refresh Kafka Record Header Viewer Headers are a list, not a map Kafka Topic Regex Subscription Tester Kafka matches the whole name Kafka ACL Permission Matrix Viewer DENY beats every ALLOW Kafka Connect Config Validator The mistakes that raise no error Kafka Consumer Group Id Validator Which broker coordinates the group Kafka Partition Assignment Visualizer Leadership is the load, not replicas Kafka Consumer Assignment Visualizer The three assignors disagree Kafka ZooKeeper to KRaft Config Converter The authorizer class nobody changes Kafka Config to Strimzi Half of it belongs elsewhere Kafka Docker Compose Generator (KRaft) Reachable from inside and outside Kafka JAAS Config Decoder The line that stops SASL working Kafka CRC32C Calculator Which CRC, over which bytes Kafka Config Upgrade Checker What breaks when you upgrade Kafka Kafka Config Diff Which change actually changed something Kafka Consumer Config Linter Why the group rebalances, and where the records went Kafka Avro Schema Validator The defaults Avro accepts and rejects Kafka Schema Compatibility Checker What the registry will say, before you ask it Kafka Avro Schema Diff Which direction each change breaks Kafka Compression Comparison Measured on your bytes Kafka Delivery Semantics Exactly-once has a consumer half Kafka ksqlDB Query Builder It looks like SQL and the rules are not Kafka Connect SMT Predicate Tester negate reads backwards Kafka Streams Topology Viewer Count the repartitions Kafka Connect Pipeline Visualizer The order things really run in Kafka Protobuf Binary Decoder Works without the .proto Kafka Protobuf JSON Converter Why your JSON does not round-trip Kafka Protobuf to Avro Schema What does not survive the conversion Kafka Avro Binary Decoder Wrong schema, no error Kafka Avro JSON Converter Why the console producer rejects your line Kafka Avro Sample Data Generator Records that actually serialize Kafka JSON to Avro Schema What JSON cannot tell you Kafka JSON Schema to Avro What does not survive the conversion Kafka SASL JAAS Generator One login module, four syntaxes Kafka CLI Command Builder kcat is librdkafka, not Kafka

    Elsewhere on the site