Skip to content

Commit 2753c64

Browse files
committed
Document broker compatibility (as suggested in #24)
1 parent d12fad9 commit 2753c64

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,29 @@ c.close()
4848
See [examples](examples) for more examples.
4949

5050

51+
Broker compatibility
52+
====================
53+
The Python client (as well as the underlying C library librdkafka) supports
54+
all broker versions >= 0.8.
55+
But due to the nature of the Kafka protocol in broker versions 0.8 and 0.9 it
56+
is not safe for a client to assume what protocol version is actually supported
57+
by the broker, thus you will need to hint the Python client what protocol
58+
version it may use. This is done through two configuration settings:
59+
60+
* `broker.version.fallback=YOUR_BROKER_VERSION` (default 0.9.0.1)
61+
* `api.version.request=true|false` (default false)
62+
63+
When using a Kafka 0.10 broker or later you only need to set
64+
`api.version.request=true`.
65+
If you use Kafka broker 0.9 or 0.8 you should leave
66+
`api.version.request=false` (default) and set
67+
`broker.version.fallback` to your broker version,
68+
e.g `broker.version.fallback=0.9.0.1`.
69+
70+
More info here:
71+
https://github.com/edenhill/librdkafka/wiki/Broker-version-compatibility
72+
73+
5174
Prerequisites
5275
=============
5376

0 commit comments

Comments
 (0)