[jira] [Comment Edited] (KAFKA-3360) Add a protocol page/section to the official Kafka documentation

2016-06-30 Thread Petr Novotnik (JIRA)

[ 
https://issues.apache.org/jira/browse/KAFKA-3360?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15356947#comment-15356947
 ] 

Petr Novotnik edited comment on KAFKA-3360 at 6/30/16 8:56 PM:
---

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|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-GroupCoordinatorResponse]
 to 
[MetadataResponse.Broker#NodeId|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-MetadataResponse].
 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|http://kafka.apache.org/protocol.html] 
seems to clarify my questions by referring to the field not as 
{{CoordinatorId}} but rather as {{node_id}} and documenting it as "broker id".


was (Author: pnovotnik_szn):
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|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-GroupCoordinatorResponse]
 to 
[MetadataResponse.Broker#NodeId|https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-MetadataResponse].
 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"?


> Add a protocol page/section to the official Kafka documentation
> ---
>
> Key: KAFKA-3360
> URL: https://issues.apache.org/jira/browse/KAFKA-3360
> Project: Kafka
>  Issue Type: Improvement
>Reporter: Grant Henke
>Assignee: Grant Henke
> Fix For: 0.10.1.0
>
>
> 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. 



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


[jira] [Comment Edited] (KAFKA-3360) Add a protocol page/section to the official Kafka documentation

2016-03-19 Thread Greg Fodor (JIRA)

[ 
https://issues.apache.org/jira/browse/KAFKA-3360?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15198422#comment-15198422
 ] 

Greg Fodor edited comment on KAFKA-3360 at 3/16/16 11:39 PM:
-

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:

{code}
[TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize MessageSet]] 
ThrottleTime
{code}

Should instead read:

{code}
ThrottleTime [TopicName [Partition ErrorCode HighwaterMarkOffset MessageSetSize 
MessageSet]]
{code}

The main Kafka protocol docs reflect this properly.


was (Author: gfodor):
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.

> Add a protocol page/section to the official Kafka documentation
> ---
>
> Key: KAFKA-3360
> URL: https://issues.apache.org/jira/browse/KAFKA-3360
> Project: Kafka
>  Issue Type: Improvement
>Reporter: Grant Henke
>Assignee: Grant Henke
> Fix For: 0.10.0.0
>
>
> 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. 



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