librdkafka icon indicating copy to clipboard operation
librdkafka copied to clipboard

Docs bug: `fetch.wait.max.ms` in consumer config but shows `fetch.max.wait.ms` in official docs

Open dingo4dev opened this issue 4 months ago • 0 comments

Issue

There's a discrepancy between the parameter name used in the confluent-kafka-python library and what's documented in the official Confluent documentation:

  • The Python client requires fetch.wait.max.ms (correct parameter)
  • The official documentation incorrectly shows fetch.max.wait.ms

This causes confusion as seen where users following the documentation encounter errors because they're using the wrong parameter name.

https://github.com/confluentinc/librdkafka/blob/2af6749287b3695edf2421631ebf08d6bcb176e3/src/rdkafka_conf.h#L373

[!CAUTION] The Python client is wrapping librdkafka (C library), which uses fetch.wait.max.ms, while the Kafka broker configuration and Java client use fetch.max.wait.ms. This causes confusion for users who follow the official documentation and encounter errors. Javadoc: ConsumerConfig

Related Issues

dingo4dev avatar Jun 14 '25 14:06 dingo4dev