Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-3360

Add a protocol page/section to the official Kafka documentation

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      This is an umbrella jira to track adding a protocol page/section to the official Kafka documentation. It lays out subtasks for initial content and follow up improvements and fixes.

        Issue Links

          Activity

          Hide
          gfodor Greg Fodor added a comment - - edited

          Apologies as I did not really know the best place to put this, and wasn't sure of the proper way to correct things myself, but I wanted to report an error in the documentation at:

          https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol

          The v1 FetchResponse protocol states that the ThrottleTime field is reported after the messages, but in fact the ThrottleTime precedes the message set. So the line:

          [TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize MessageSet]] ThrottleTime
          

          Should instead read:

          ThrottleTime [TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize MessageSet]]
          

          The main Kafka protocol docs reflect this properly.

          Show
          gfodor Greg Fodor added a comment - - edited Apologies as I did not really know the best place to put this, and wasn't sure of the proper way to correct things myself, but I wanted to report an error in the documentation at: https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol The v1 FetchResponse protocol states that the ThrottleTime field is reported after the messages, but in fact the ThrottleTime precedes the message set. So the line: [TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize MessageSet]] ThrottleTime Should instead read: ThrottleTime [TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize MessageSet]] The main Kafka protocol docs reflect this properly.
          Hide
          pnovotnik_szn Petr Novotnik added a comment - - edited

          I'm sorry, but I also cannot find a better place to ask for the following: would it be possible to document the relation of GroupCoordinatorResponse#CoordinatorId to MetadataResponse.Broker#NodeId. Are the IDs of the two entities distinct even if equal by "host:port"? Or is it guaranteed the IDs will be the same if the entities equal by "host:port"?

          Update: The new protocol documentation seems to clarify my questions by referring to the field not as CoordinatorId but rather as node_id and documenting it as "broker id".

          Show
          pnovotnik_szn Petr Novotnik added a comment - - edited I'm sorry, but I also cannot find a better place to ask for the following: would it be possible to document the relation of GroupCoordinatorResponse#CoordinatorId to MetadataResponse.Broker#NodeId . Are the IDs of the two entities distinct even if equal by "host:port"? Or is it guaranteed the IDs will be the same if the entities equal by "host:port"? Update: The new protocol documentation seems to clarify my questions by referring to the field not as CoordinatorId but rather as node_id and documenting it as "broker id".

            People

            • Assignee:
              granthenke Grant Henke
              Reporter:
              granthenke Grant Henke
            • Votes:
              2 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

              • Created:
                Updated:

                Development