[ 
https://issues.apache.org/jira/browse/KAFKA-3698?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

David Kay updated KAFKA-3698:
-----------------------------
    Comment: was deleted

(was: Kafka documentation on message formats needs to be more explicit for new 
users.   Section 1.3 Step 4 says: "Send some messages" and takes lines of text 
from the command line.   Beginner's guide 
(http://www.slideshare.net/miguno/apache-kafka-08-basic-training-verisign Slide 
104 says:
{noformat}
   Kafka does not care about data format of msg payload
   Up to developer to handle serialization/deserialization
      Common choices: Avro, JSON
{noformat}

If one producer sends lines of console text, another producer sends Avro, a 
third producer sends JSON, and a fourth sends CBOR, how does the consumer 
identify which deserializer to use for the payload?  A single byte (Section 5.4 
attribute - "type of codec used") presumably isn't enough to signal all 
possible codecs, and there is no information on where codec types are 
registered (e.g., no IANA list for Kafka codecs).  Document needs to describe 
how consumer identifies payload format.)

> Update website documentation when it comes to the message format
> ----------------------------------------------------------------
>
>                 Key: KAFKA-3698
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3698
>             Project: Kafka
>          Issue Type: Improvement
>            Reporter: Ismael Juma
>            Assignee: Jiangjie Qin
>             Fix For: 0.10.0.0
>
>
> Sections 5.3, 5.4 and 5.5 talk about the message format:
> http://kafka.apache.org/documentation.html#messages
> We should make sure they are up to date given recent changes.
> [~becket_qin], do you think you could do this?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to