[KAFKA-4638] Outdated and misleading link in section "End-to-end Batch Compression"

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Duplicate
• Affects Version/s: 0.10.1.1
• Component/s: compression
• Environment: Documentation
• Assignee: Unassigned
• Reporter: Vincent Tieleman
• Created: 16/Jan/17 19:25
• Updated: 08/Sep/17 11:02
• Resolved: 08/Sep/17 11:02

Description

The section "End-to-end Batch Compression" mentions the following:
"Kafka supports GZIP, Snappy and LZ4 compression protocols. More details on compression can be found here."

When looking up the "here" link, https://cwiki.apache.org/confluence/display/KAFKA/Compression, it describes not only the mechanism, but also gives the configuration properties to use. The properties provided are "compression.codec" and "compression.topics", but these are no longer used. Instead, one should use "compression.type", where one can directly specify which compression to use (i.e. currently gzip, snappy or lz4). The link also fails to mention lz4 compression, which is supported by now.

Not aware that this information is outdated, I spent quite some time before finding out that I was using the wrong properties. I imagine this must happen to more people.

I suggest adding a small remark to the link, so that people know it is outdated. Furthermore, I would add that the latest configuration properties can be found in the "Producer config" section.

The alternative would be to simply remove the link all together, as there is too much outdated information in it.

Issue Links

• is duplicated by: KAFKA-5686 Documentation inconsistency on the "Compression"