Kafka Streams — Architect, Build, Debug
JVM-embedded stream processing library with no separate cluster.
⚠️ IMPORTANT: Lazy-Load References Only
Do NOT read all reference files upfront. Read ONLY what you need, when you need it.
- User asks "how do I join two topics?" → Read
references/topology-patterns.md
§ Joins Decision Tree only
- User asks "build me a Kafka Streams app" → Read
references/build-templates.md
when writing build files, not before
- User asks "my app is crashing" → Read the specific section in for that symptom
- Most questions need 0-2 reference files total, not all 10
Never read multiple files preemptively "just in case"
Always Confirm Target Environment First
Before answering in any mode (Architect, Build, Debug), confirm the target environment if the user hasn't stated it: Apache Kafka | Confluent Platform | Confluent Cloud | WarpStream. Versions/auth shape every recommendation — KIP-1071 support, SASL config, ACL model, transactional-id expiry, CLI tool names all branch on this. Skip the question only if the user already named the environment.
If the user selects WarpStream: Read
references/warpstream-optimization.md
and apply its overrides on top of the standard config baseline. Key impacts for Kafka Streams:
- EOS has a significant throughput cost — enables idempotent producers internally, which reduces throughput on WarpStream due to limited in-flight request concurrency. Default to with downstream deduplication unless the user has a strong need for EOS.
- Producer and consumer configs must be overridden (larger batches, higher linger, larger fetches). See the "Kafka Streams Specific" section in the shared reference.
- is not supported — do not set it.
- is cosmetic (always 3) — do not tune it.
- Zone-aware routing via with suffix is critical for cost.
- Latency is higher (~250ms p50 produce vs single-digit ms on Kafka) — set expectations with the user.
Mode Detection
Determine the user's intent and enter the appropriate mode:
| User intent | Mode | What to do |
|---|
| "I need to process events from topic X..." / "Build me a KS app..." / "I want to aggregate/filter/join..." | Build | Go to Build Mode |
| "How should I design my topology?" / "Should I use a KTable or GlobalKTable?" / "What join type do I need?" / "How do I handle late events?" | Architect | Go to Architect Mode |
| "My Streams app is stuck/slow/crashing..." / "Why am I getting rebalancing loops?" / "How do I interpret this metric?" | Debug | Go to Debug Mode |
If unclear, default to Architect — understand the problem before generating code.
Flink-first check (Confluent Cloud only)
If user asks for generic stream processing on CC without mentioning KS, briefly offer Flink as alternative. Don't lecture.
Architect Mode
Design the right topology. Translate user's data problem into KS primitives.
Step 1: Understand the Data Problem
Confirm target environment first (see preamble). Then ask (skip if answered): What data (topics)? What output? Relationship between inputs (combine/enrich/group)?
Step 2: Recommend the Topology Pattern
Match problem to pattern (read
references/topology-patterns.md
only for the specific pattern needed). Present: why it fits, data flow in plain English, KS primitives involved, tradeoffs/alternatives.
Key Decision Trees
When needed, read only the relevant section:
- Combine topics:
references/topology-patterns.md
§ Joins Decision Tree
- Aggregate over time:
references/topology-patterns.md
§ Windowing Decision Tree
- Enrichment/lookup:
references/topology-patterns.md
§ Enrichment Patterns
- Exactly-once:
references/topology-patterns.md
§ Exactly-Once (walk through before recommending — at-least-once is simpler if downstream can dedupe)
After user confirms, go to Build Mode.
Build Mode
Generate a complete, runnable Kafka Streams project.
Step 1: Gather Requirements
Ask (skip if already answered):
- What does your app do? Push back on vague requests.
- Topics & data flow: Input/output topics? Schematized? If yes, retrieve schema (don't generate new ones). How do topics connect (joins/lookups/independent)?
- Schema format (skip if using existing): Avro (default) | Protobuf | JSON Schema
- Build tool: Gradle (default) | Maven
- Target environment (REQUIRED): Apache Kafka | Confluent Platform | Confluent Cloud | WarpStream (read
references/config-baseline.md
when generating config; if WarpStream, also read references/warpstream-optimization.md
for client overrides)
- Credentials: CC needs 2 API keys (Kafka + SR). CP/AK needs bootstrap + SR URLs + auth type (read
references/cli-commands.md
if needed)
- Deployment sizing: Partitions? Instances? State size? (read
references/architecture.md
or references/production-hardening.md
§ Deployment Sizing if needed)
- Test data: Has data or wants sample data generated?
Step 2: Plan Resources
Present plan: topics to create (source/output/DLQ), schemas to register. Changelog/repartition topics auto-created by KS.
If the user says input topics already exist, omit them from — the script should only create new topics (typically output + DLQ).
Step 3: Generate the Project
Generate: project structure, schemas, App.java, TopologyBuilder.java, config, simplelogger.properties, docker-compose (if local), scripts, TopologyTest.java, .env.example, monitoring comments.
Read references only as needed:
- Topology code? →
references/topology-patterns.md
for the specific pattern
- Build file structure? →
references/build-templates.md
- Schema syntax? →
references/schema-patterns.md
- Config properties? →
references/config-baseline.md
for env-specific blocks
- Scripts? → ,
- Local dev? →
references/docker-compose.md
Gradle: Run
gradle wrapper --gradle-version 8.12
after creating build files.
If user wants sample data: generate SampleDataProducer.java and
task.
Step 4: Production Hardening (if production target)
Trigger: User says "production"/"prod"/"deploy" or specifies K8s/ECS/Docker Swarm or requests multiple instances.
Add production components (read
references/production-hardening.md
for details if needed): Logback JSON logging,
, health check endpoint,
with JVM tuning, KIP-1034 DLQ handler, K8s YAML (if K8s), shadow/fat jar plugin.
Step 5: Walk Through the Code
Explain topology, config choices, how to run, what to monitor. Mention
(KIP-1071) provides 50-80% faster rebalancing (requires AK 4.2+/CP 8.2+).
Step 6: Run the App Before Handing Off
You must actually start the app against a real broker and observe it reach before declaring the task done. Generated code that compiles and passes
tests can still fail at startup — version-mismatch
s, silent logger fallbacks, missing runtime deps, and import-path errors all slip past
+
and only surface against a real broker / Schema Registry. A green build is not a working app.
Branch on the target environment chosen in Step 1:
Local (Apache Kafka or Confluent Platform via the generated ):
- and wait for Kafka + SR to be healthy (, or curl SR )
- Start the app in the background ( or ) so you can read its logs while it runs
- Tail the log and confirm
State transition from REBALANCING to RUNNING
within ~30s. If you don't see it, read the actual stack trace, diagnose via § Startup Failures, fix, restart, re-verify
- If the user wanted sample data: produce a few records and confirm output appears on the destination topic
- Stop the app and (or leave running if the user wants to keep iterating — ask)
Confluent Cloud:
You usually cannot run end-to-end yourself because the cluster + SR API keys are the user's. Do the most you can without them, then hand off the rest:
- If has real CC creds (the user has set up a real ): run the app locally pointed at CC ( auto-loads ) and follow steps 3–5 above. Don't skip just because it's CC — if you have creds, run it.
- If creds are placeholders or not provided: do not fabricate a successful run. Instead:
- Run (compile + unit tests) and report the result
- List the exact commands the user must run to verify (
./create-topics.sh --cloud
, , the consume command from references/verification.md
§ Confluent Cloud) and what success looks like (State transition from REBALANCING to RUNNING
, records on the output topic)
- Tell the user explicitly: "I couldn't run this against your CC cluster because I don't have your API keys — please run the steps above and paste any errors back."
WarpStream:
You usually cannot run end-to-end yourself because the WarpStream cluster and credentials are the user's. Follow the same approach as Confluent Cloud:
- If has real WarpStream creds: run the app locally ( auto-loads ) and follow the Local steps 3–5 above. Note that
State transition from REBALANCING to RUNNING
may take longer due to WarpStream's higher metadata latency.
- If creds are placeholders or not provided: do not fabricate a successful run. Instead:
- Run (compile + unit tests) and report the result
- List the exact commands the user must run to verify (, ) and what success looks like (
State transition from REBALANCING to RUNNING
, records on the output topic)
- Remind the user to set with in their for zone-aware routing
- Tell the user explicitly: "I couldn't run this against your WarpStream cluster because I don't have your credentials — please run the steps above and paste any errors back."
In the handoff, state plainly which of the above you did. If you ran it and saw
, say so. If you only compiled, say only that. Don't imply a runtime verification you didn't perform.
For CC consume commands, schema-aware producers, and reset procedures, read
references/verification.md
.
Debug Mode
Step 1: Classify the Problem
| Symptom | Category | Go to |
|---|
| App crashes on startup | Startup failure | § Startup Failures |
| App runs but no output / stops processing | Processing stall | § Processing Stalls |
| Rebalancing loops / constant rebalancing | Rebalancing | § Rebalancing Issues |
| High lag / slow processing | Performance | § Performance |
| Deserialization errors / poison pills | Data quality | § Deserialization Errors |
| State store issues (corruption, growth, recovery) | State | § State Store Issues |
Thread failures / StreamsUncaughtExceptionHandler
| Thread health | § Thread Failures |
| Memory issues (OOM, high heap, RocksDB) | Memory | § Memory Issues |
| Low throughput or KAFKA_STORAGE_ERROR on WarpStream | WarpStream config | references/warpstream-optimization.md
|
Step 2: Gather Context
Confirm target environment first (see preamble) — most debug paths branch on it. Then ask for: error message, config, KS/Java versions, new app or regression?
Step 3: Diagnose and Fix
Read the relevant section in
for the identified category. Provide fix with explanation.
Invariant Checklist
Non-negotiable defaults. Apply all. Read reference files only if you need implementation details.
- Schematized data: SR serdes (, , ). Set , , . JSON Schema: set . Protobuf: set
specific.protobuf.value.type
(references/config-baseline.md)
- Versions: KS 4.x / CP 8.x, Java 17+
- KIP-1071: (default). Remove if
UnsupportedVersionException
. Unsupported: static membership, regex topics, standby replicas, warm-up replicas (references/topology-patterns.md § Assignment Strategy)
- Four-tier error handling:
DeserializationExceptionHandler
, ProcessingExceptionHandler
(KIP-1034), ProductionExceptionHandler
, StreamsUncaughtExceptionHandler
. Use MaxFailures pattern for uncaught (references/production-hardening.md § Error Handling)
- Explicit naming:
ensure.explicit.internal.resource.naming=true
- Graceful shutdown: Hook with on SIGTERM/SIGINT
- Monitoring:
metrics.recording.level=INFO
(references/config-baseline.md)
- Log verbosity: Generate (references/build-templates.md)
- Defensive topology: Guard lambdas in prod (null checks, try/catch). Dev: simpler is fine.
- Schema parity: Avro/Protobuf/JSON Schema all supported (references/build-templates.md, references/schema-patterns.md)
- Test caching: TopologyTestDriver tests need
statestore.cache.max.bytes=0
to avoid non-deterministic assertions.
- Avro logical type Java mappings: Avro 1.12+ generates for /, for , for , etc. Never use raw / literals with generated setter methods — use , ,
Instant.ofEpochMilli(...)
. Use / instead of / for timestamp comparisons. Applies to topology code, aggregation initializers, producers, AND test helpers (references/schema-patterns.md § Java type mapping).
Bundled Scripts
:
(pre-create topics,
),
(delete topics/state,
),
(generate if requested).
Reference Files (read on-demand only)
references/topology-patterns.md
— design, joins, windows, aggregations |
references/architecture.md
— internals, sizing |
— troubleshooting |
references/config-baseline.md
— config |
references/build-templates.md
— project structure |
references/schema-patterns.md
— Avro/Protobuf/JSON |
references/production-hardening.md
— prod setup |
references/cli-commands.md
— CLI |
references/docker-compose.md
— local dev |
references/verification.md
— checklists |
references/warpstream-optimization.md
— WarpStream client config overrides