http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/generated/protocol_errors.html ---------------------------------------------------------------------- diff --git a/0101/generated/protocol_errors.html b/0101/generated/protocol_errors.html new file mode 100644 index 0000000..fc6d31a --- /dev/null +++ b/0101/generated/protocol_errors.html @@ -0,0 +1,53 @@ +<table class="data-table"><tbody> +<tr><th>Error</th> +<th>Code</th> +<th>Retriable</th> +<th>Description</th> +</tr> +<tr><td>UNKNOWN</td><td>-1</td><td>False</td><td>The server experienced an unexpected error when processing the request</td></tr> +<tr><td>NONE</td><td>0</td><td>False</td><td></td></tr> +<tr><td>OFFSET_OUT_OF_RANGE</td><td>1</td><td>False</td><td>The requested offset is not within the range of offsets maintained by the server.</td></tr> +<tr><td>CORRUPT_MESSAGE</td><td>2</td><td>True</td><td>This message has failed its CRC checksum, exceeds the valid size, or is otherwise corrupt.</td></tr> +<tr><td>UNKNOWN_TOPIC_OR_PARTITION</td><td>3</td><td>True</td><td>This server does not host this topic-partition.</td></tr> +<tr><td>INVALID_FETCH_SIZE</td><td>4</td><td>False</td><td>The requested fetch size is invalid.</td></tr> +<tr><td>LEADER_NOT_AVAILABLE</td><td>5</td><td>True</td><td>There is no leader for this topic-partition as we are in the middle of a leadership election.</td></tr> +<tr><td>NOT_LEADER_FOR_PARTITION</td><td>6</td><td>True</td><td>This server is not the leader for that topic-partition.</td></tr> +<tr><td>REQUEST_TIMED_OUT</td><td>7</td><td>True</td><td>The request timed out.</td></tr> +<tr><td>BROKER_NOT_AVAILABLE</td><td>8</td><td>False</td><td>The broker is not available.</td></tr> +<tr><td>REPLICA_NOT_AVAILABLE</td><td>9</td><td>False</td><td>The replica is not available for the requested topic-partition</td></tr> +<tr><td>MESSAGE_TOO_LARGE</td><td>10</td><td>False</td><td>The request included a message larger than the max message size the server will accept.</td></tr> +<tr><td>STALE_CONTROLLER_EPOCH</td><td>11</td><td>False</td><td>The controller moved to another broker.</td></tr> +<tr><td>OFFSET_METADATA_TOO_LARGE</td><td>12</td><td>False</td><td>The metadata field of the offset request was too large.</td></tr> +<tr><td>NETWORK_EXCEPTION</td><td>13</td><td>True</td><td>The server disconnected before a response was received.</td></tr> +<tr><td>GROUP_LOAD_IN_PROGRESS</td><td>14</td><td>True</td><td>The coordinator is loading and hence can't process requests for this group.</td></tr> +<tr><td>GROUP_COORDINATOR_NOT_AVAILABLE</td><td>15</td><td>True</td><td>The group coordinator is not available.</td></tr> +<tr><td>NOT_COORDINATOR_FOR_GROUP</td><td>16</td><td>True</td><td>This is not the correct coordinator for this group.</td></tr> +<tr><td>INVALID_TOPIC_EXCEPTION</td><td>17</td><td>False</td><td>The request attempted to perform an operation on an invalid topic.</td></tr> +<tr><td>RECORD_LIST_TOO_LARGE</td><td>18</td><td>False</td><td>The request included message batch larger than the configured segment size on the server.</td></tr> +<tr><td>NOT_ENOUGH_REPLICAS</td><td>19</td><td>True</td><td>Messages are rejected since there are fewer in-sync replicas than required.</td></tr> +<tr><td>NOT_ENOUGH_REPLICAS_AFTER_APPEND</td><td>20</td><td>True</td><td>Messages are written to the log, but to fewer in-sync replicas than required.</td></tr> +<tr><td>INVALID_REQUIRED_ACKS</td><td>21</td><td>False</td><td>Produce request specified an invalid value for required acks.</td></tr> +<tr><td>ILLEGAL_GENERATION</td><td>22</td><td>False</td><td>Specified group generation id is not valid.</td></tr> +<tr><td>INCONSISTENT_GROUP_PROTOCOL</td><td>23</td><td>False</td><td>The group member's supported protocols are incompatible with those of existing members.</td></tr> +<tr><td>INVALID_GROUP_ID</td><td>24</td><td>False</td><td>The configured groupId is invalid</td></tr> +<tr><td>UNKNOWN_MEMBER_ID</td><td>25</td><td>False</td><td>The coordinator is not aware of this member.</td></tr> +<tr><td>INVALID_SESSION_TIMEOUT</td><td>26</td><td>False</td><td>The session timeout is not within the range allowed by the broker (as configured by group.min.session.timeout.ms and group.max.session.timeout.ms).</td></tr> +<tr><td>REBALANCE_IN_PROGRESS</td><td>27</td><td>False</td><td>The group is rebalancing, so a rejoin is needed.</td></tr> +<tr><td>INVALID_COMMIT_OFFSET_SIZE</td><td>28</td><td>False</td><td>The committing offset data size is not valid</td></tr> +<tr><td>TOPIC_AUTHORIZATION_FAILED</td><td>29</td><td>False</td><td>Not authorized to access topics: [Topic authorization failed.]</td></tr> +<tr><td>GROUP_AUTHORIZATION_FAILED</td><td>30</td><td>False</td><td>Not authorized to access group: Group authorization failed.</td></tr> +<tr><td>CLUSTER_AUTHORIZATION_FAILED</td><td>31</td><td>False</td><td>Cluster authorization failed.</td></tr> +<tr><td>INVALID_TIMESTAMP</td><td>32</td><td>False</td><td>The timestamp of the message is out of acceptable range.</td></tr> +<tr><td>UNSUPPORTED_SASL_MECHANISM</td><td>33</td><td>False</td><td>The broker does not support the requested SASL mechanism.</td></tr> +<tr><td>ILLEGAL_SASL_STATE</td><td>34</td><td>False</td><td>Request is not valid given the current SASL state.</td></tr> +<tr><td>UNSUPPORTED_VERSION</td><td>35</td><td>False</td><td>The version of API is not supported.</td></tr> +<tr><td>TOPIC_ALREADY_EXISTS</td><td>36</td><td>False</td><td>Topic with this name already exists.</td></tr> +<tr><td>INVALID_PARTITIONS</td><td>37</td><td>False</td><td>Number of partitions is invalid.</td></tr> +<tr><td>INVALID_REPLICATION_FACTOR</td><td>38</td><td>False</td><td>Replication-factor is invalid.</td></tr> +<tr><td>INVALID_REPLICA_ASSIGNMENT</td><td>39</td><td>False</td><td>Replica assignment is invalid.</td></tr> +<tr><td>INVALID_CONFIG</td><td>40</td><td>False</td><td>Configuration is invalid.</td></tr> +<tr><td>NOT_CONTROLLER</td><td>41</td><td>True</td><td>This is not the correct controller for this cluster.</td></tr> +<tr><td>INVALID_REQUEST</td><td>42</td><td>False</td><td>This most likely occurs because of a request being malformed by the client library or the message was sent to an incompatible broker. See the broker logs for more details.</td></tr> +<tr><td>UNSUPPORTED_FOR_MESSAGE_FORMAT</td><td>43</td><td>False</td><td>The message format version on the broker does not support the request.</td></tr> +</table> +
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/generated/protocol_messages.html ---------------------------------------------------------------------- diff --git a/0101/generated/protocol_messages.html b/0101/generated/protocol_messages.html new file mode 100644 index 0000000..11dad58 --- /dev/null +++ b/0101/generated/protocol_messages.html @@ -0,0 +1,1843 @@ +<h5>Headers:</h5> +<pre>Request Header => api_key api_version correlation_id client_id + api_key => INT16 + api_version => INT16 + correlation_id => INT32 + client_id => NULLABLE_STRING +</pre> +<table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>api_key</td><td>The id of the request type.</td></tr> +<tr> +<td>api_version</td><td>The version of the API.</td></tr> +<tr> +<td>correlation_id</td><td>A user-supplied integer value that will be passed back with the response</td></tr> +<tr> +<td>client_id</td><td>A user specified identifier for the client making the request.</td></tr> +</table> +<pre>Response Header => correlation_id + correlation_id => INT32 +</pre> +<table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>correlation_id</td><td>The user-supplied value passed in with the request</td></tr> +</table> +<h5>Produce API (Key: 0):</h5> + +<b>Requests:</b><br> +<p><pre>Produce Request (Version: 0) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>data</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 1) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>data</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 2) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>data</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Produce Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset + partition => INT32 + error_code => INT16 + base_offset => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>base_offset</td><td></td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 1) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset + partition => INT32 + error_code => INT16 + base_offset => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>base_offset</td><td></td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation. (Zero if the request did not violate any quota.)</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 2) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset timestamp + partition => INT32 + error_code => INT16 + base_offset => INT64 + timestamp => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>base_offset</td><td></td></tr> +<tr> +<td>timestamp</td><td>The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended.</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation. (Zero if the request did not violate any quota.)</td></tr> +</table> +</p> +<h5>Fetch API (Key: 1):</h5> + +<b>Requests:</b><br> +<p><pre>Fetch Request (Version: 0) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 1) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 2) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 3) => replica_id max_wait_time min_bytes max_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + max_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to accumulate in the response. Note that this is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that progress can be made.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch in the order provided.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Fetch Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code high_watermark record_set + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 1) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code high_watermark record_set + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation. (Zero if the request did not violate any quota.)</td></tr> +<tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 2) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code high_watermark record_set + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation. (Zero if the request did not violate any quota.)</td></tr> +<tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 3) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code high_watermark record_set + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation. (Zero if the request did not violate any quota.)</td></tr> +<tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td></td></tr> +</table> +</p> +<h5>Offsets API (Key: 2):</h5> + +<b>Requests:</b><br> +<p><pre>Offsets Request (Version: 0) => replica_id [topics] + replica_id => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition timestamp max_num_offsets + partition => INT32 + timestamp => INT64 + max_num_offsets => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>topics</td><td>Topics to list offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to list offset.</td></tr> +<tr> +<td>partitions</td><td>Partitions to list offset.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>timestamp</td><td>Timestamp.</td></tr> +<tr> +<td>max_num_offsets</td><td>Maximum offsets to return.</td></tr> +</table> +</p> +<p><pre>Offsets Request (Version: 1) => replica_id [topics] + replica_id => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition timestamp + partition => INT32 + timestamp => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>topics</td><td>Topics to list offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to list offset.</td></tr> +<tr> +<td>partitions</td><td>Partitions to list offset.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>timestamp</td><td>The target timestamp for the partition.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Offsets Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code [offsets] + partition => INT32 + error_code => INT16 + offsets => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>offsets</td><td>A list of offsets.</td></tr> +</table> +</p> +<p><pre>Offsets Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code timestamp offset + partition => INT32 + error_code => INT16 + timestamp => INT64 + offset => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>timestamp</td><td>The timestamp associated with the returned offset</td></tr> +<tr> +<td>offset</td><td>offset found</td></tr> +</table> +</p> +<h5>Metadata API (Key: 3):</h5> + +<b>Requests:</b><br> +<p><pre>Metadata Request (Version: 0) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If no topics are specified fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 1) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 2) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Metadata Response (Version: 0) => [brokers] [topic_metadata] + brokers => node_id host port + node_id => INT32 + host => STRING + port => INT32 + topic_metadata => topic_error_code topic [partition_metadata] + topic_error_code => INT16 + topic => STRING + partition_metadata => partition_error_code partition_id leader [replicas] [isr] + partition_error_code => INT16 + partition_id => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>topic_metadata</td><td></td></tr> +<tr> +<td>topic_error_code</td><td>The error code for the given topic.</td></tr> +<tr> +<td>topic</td><td>The name of the topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>partition_error_code</td><td>The error code for the partition, if any.</td></tr> +<tr> +<td>partition_id</td><td>The id of the partition.</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 1) => [brokers] controller_id [topic_metadata] + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + controller_id => INT32 + topic_metadata => topic_error_code topic is_internal [partition_metadata] + topic_error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => partition_error_code partition_id leader [replicas] [isr] + partition_error_code => INT16 + partition_id => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td></td></tr> +<tr> +<td>topic_error_code</td><td>The error code for the given topic.</td></tr> +<tr> +<td>topic</td><td>The name of the topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>partition_error_code</td><td>The error code for the partition, if any.</td></tr> +<tr> +<td>partition_id</td><td>The id of the partition.</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 2) => [brokers] cluster_id controller_id [topic_metadata] + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + cluster_id => NULLABLE_STRING + controller_id => INT32 + topic_metadata => topic_error_code topic is_internal [partition_metadata] + topic_error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => partition_error_code partition_id leader [replicas] [isr] + partition_error_code => INT16 + partition_id => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>cluster_id</td><td>The cluster id that this broker belongs to.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td></td></tr> +<tr> +<td>topic_error_code</td><td>The error code for the given topic.</td></tr> +<tr> +<td>topic</td><td>The name of the topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>partition_error_code</td><td>The error code for the partition, if any.</td></tr> +<tr> +<td>partition_id</td><td>The id of the partition.</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<h5>LeaderAndIsr API (Key: 4):</h5> + +<b>Requests:</b><br> +<p><pre>LeaderAndIsr Request (Version: 0) => controller_id controller_epoch [partition_states] [live_leaders] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_leaders => id host port + id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_leaders</td><td></td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>LeaderAndIsr Response (Version: 0) => error_code [partitions] + error_code => INT16 + partitions => topic partition error_code + topic => STRING + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +<tr> +<td>partitions</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td>Error code.</td></tr> +</table> +</p> +<h5>StopReplica API (Key: 5):</h5> + +<b>Requests:</b><br> +<p><pre>StopReplica Request (Version: 0) => controller_id controller_epoch delete_partitions [partitions] + controller_id => INT32 + controller_epoch => INT32 + delete_partitions => BOOLEAN + partitions => topic partition + topic => STRING + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>delete_partitions</td><td>Boolean which indicates if replica's partitions must be deleted.</td></tr> +<tr> +<td>partitions</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>StopReplica Response (Version: 0) => error_code [partitions] + error_code => INT16 + partitions => topic partition error_code + topic => STRING + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +<tr> +<td>partitions</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td>Error code.</td></tr> +</table> +</p> +<h5>UpdateMetadata API (Key: 6):</h5> + +<b>Requests:</b><br> +<p><pre>UpdateMetadata Request (Version: 0) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id host port + id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td></td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 1) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id [end_points] + id => INT32 + end_points => port host security_protocol_type + port => INT32 + host => STRING + security_protocol_type => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td></td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td></td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 2) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id [end_points] rack + id => INT32 + end_points => port host security_protocol_type + port => INT32 + host => STRING + security_protocol_type => INT16 + rack => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td></td></tr> +<tr> +<td>topic</td><td>Topic name.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td></td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td></td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +<tr> +<td>rack</td><td>The rack</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>UpdateMetadata Response (Version: 0) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 1) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 2) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +</table> +</p> +<h5>ControlledShutdown API (Key: 7):</h5> + +<b>Requests:</b><br> +</p> +<p><pre>ControlledShutdown Request (Version: 1) => broker_id + broker_id => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>broker_id</td><td>The id of the broker for which controlled shutdown has been requested.</td></tr> +</table> +</p> +<b>Responses:</b><br> +</p> +<p><pre>ControlledShutdown Response (Version: 1) => error_code [partitions_remaining] + error_code => INT16 + partitions_remaining => topic partition + topic => STRING + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>partitions_remaining</td><td>The partitions that the broker still leads.</td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +</table> +</p> +<h5>OffsetCommit API (Key: 8):</h5> + +<b>Requests:</b><br> +<p><pre>OffsetCommit Request (Version: 0) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition offset metadata + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to commit.</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<p><pre>OffsetCommit Request (Version: 1) => group_id group_generation_id member_id [topics] + group_id => STRING + group_generation_id => INT32 + member_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition offset timestamp metadata + partition => INT32 + offset => INT64 + timestamp => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>group_generation_id</td><td>The generation of the group.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to commit.</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>timestamp</td><td>Timestamp of the commit</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<p><pre>OffsetCommit Request (Version: 2) => group_id group_generation_id member_id retention_time [topics] + group_id => STRING + group_generation_id => INT32 + member_id => STRING + retention_time => INT64 + topics => topic [partitions] + topic => STRING + partitions => partition offset metadata + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>group_generation_id</td><td>The generation of the consumer group.</td></tr> +<tr> +<td>member_id</td><td>The consumer id assigned by the group coordinator.</td></tr> +<tr> +<td>retention_time</td><td>Time period in ms to retain the offset.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to commit.</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>OffsetCommit Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<p><pre>OffsetCommit Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<p><pre>OffsetCommit Response (Version: 2) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<h5>OffsetFetch API (Key: 9):</h5> + +<b>Requests:</b><br> +<p><pre>OffsetFetch Request (Version: 0) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The consumer group id.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch offset.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +</table> +</p> +<p><pre>OffsetFetch Request (Version: 1) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The consumer group id.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets.</td></tr> +<tr> +<td>topic</td><td>Topic to fetch offset.</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>OffsetFetch Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<p><pre>OffsetFetch Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td></td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>partition_responses</td><td></td></tr> +<tr> +<td>partition</td><td>Topic partition id.</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<h5>GroupCoordinator API (Key: 10):</h5> + +<b>Requests:</b><br> +<p><pre>GroupCoordinator Request (Version: 0) => group_id + group_id => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group id.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>GroupCoordinator Response (Version: 0) => error_code coordinator + error_code => INT16 + coordinator => node_id host port + node_id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>coordinator</td><td>Host and port information for the coordinator for a consumer group.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<h5>JoinGroup API (Key: 11):</h5> + +<b>Requests:</b><br> +<p><pre>JoinGroup Request (Version: 0) => group_id session_timeout member_id protocol_type [group_protocols] + group_id => STRING + session_timeout => INT32 + member_id => STRING + protocol_type => STRING + group_protocols => protocol_name protocol_metadata + protocol_name => STRING + protocol_metadata => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>session_timeout</td><td>The coordinator considers the consumer dead if it receives no heartbeat after this timeout in ms.</td></tr> +<tr> +<td>member_id</td><td>The assigned consumer id or an empty string for a new consumer.</td></tr> +<tr> +<td>protocol_type</td><td>Unique name for class of protocols implemented by group</td></tr> +<tr> +<td>group_protocols</td><td>List of protocols that the member supports</td></tr> +<tr> +<td>protocol_name</td><td></td></tr> +<tr> +<td>protocol_metadata</td><td></td></tr> +</table> +</p> +<p><pre>JoinGroup Request (Version: 1) => group_id session_timeout rebalance_timeout member_id protocol_type [group_protocols] + group_id => STRING + session_timeout => INT32 + rebalance_timeout => INT32 + member_id => STRING + protocol_type => STRING + group_protocols => protocol_name protocol_metadata + protocol_name => STRING + protocol_metadata => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>session_timeout</td><td>The coordinator considers the consumer dead if it receives no heartbeat after this timeout in ms.</td></tr> +<tr> +<td>rebalance_timeout</td><td>The maximum time that the coordinator will wait for each member to rejoin when rebalancing the group</td></tr> +<tr> +<td>member_id</td><td>The assigned consumer id or an empty string for a new consumer.</td></tr> +<tr> +<td>protocol_type</td><td>Unique name for class of protocols implemented by group</td></tr> +<tr> +<td>group_protocols</td><td>List of protocols that the member supports</td></tr> +<tr> +<td>protocol_name</td><td></td></tr> +<tr> +<td>protocol_metadata</td><td></td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>JoinGroup Response (Version: 0) => error_code generation_id group_protocol leader_id member_id [members] + error_code => INT16 + generation_id => INT32 + group_protocol => STRING + leader_id => STRING + member_id => STRING + members => member_id member_metadata + member_id => STRING + member_metadata => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>generation_id</td><td>The generation of the consumer group.</td></tr> +<tr> +<td>group_protocol</td><td>The group protocol selected by the coordinator</td></tr> +<tr> +<td>leader_id</td><td>The leader of the group</td></tr> +<tr> +<td>member_id</td><td>The consumer id assigned by the group coordinator.</td></tr> +<tr> +<td>members</td><td></td></tr> +<tr> +<td>member_id</td><td></td></tr> +<tr> +<td>member_metadata</td><td></td></tr> +</table> +</p> +<p><pre>JoinGroup Response (Version: 1) => error_code generation_id group_protocol leader_id member_id [members] + error_code => INT16 + generation_id => INT32 + group_protocol => STRING + leader_id => STRING + member_id => STRING + members => member_id member_metadata + member_id => STRING + member_metadata => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>generation_id</td><td>The generation of the consumer group.</td></tr> +<tr> +<td>group_protocol</td><td>The group protocol selected by the coordinator</td></tr> +<tr> +<td>leader_id</td><td>The leader of the group</td></tr> +<tr> +<td>member_id</td><td>The consumer id assigned by the group coordinator.</td></tr> +<tr> +<td>members</td><td></td></tr> +<tr> +<td>member_id</td><td></td></tr> +<tr> +<td>member_metadata</td><td></td></tr> +</table> +</p> +<h5>Heartbeat API (Key: 12):</h5> + +<b>Requests:</b><br> +<p><pre>Heartbeat Request (Version: 0) => group_id group_generation_id member_id + group_id => STRING + group_generation_id => INT32 + member_id => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>group_generation_id</td><td>The generation of the group.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Heartbeat Response (Version: 0) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<h5>LeaveGroup API (Key: 13):</h5> + +<b>Requests:</b><br> +<p><pre>LeaveGroup Request (Version: 0) => group_id member_id + group_id => STRING + member_id => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The group id.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>LeaveGroup Response (Version: 0) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<h5>SyncGroup API (Key: 14):</h5> + +<b>Requests:</b><br> +<p><pre>SyncGroup Request (Version: 0) => group_id generation_id member_id [group_assignment] + group_id => STRING + generation_id => INT32 + member_id => STRING + group_assignment => member_id member_assignment + member_id => STRING + member_assignment => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td></td></tr> +<tr> +<td>generation_id</td><td></td></tr> +<tr> +<td>member_id</td><td></td></tr> +<tr> +<td>group_assignment</td><td></td></tr> +<tr> +<td>member_id</td><td></td></tr> +<tr> +<td>member_assignment</td><td></td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>SyncGroup Response (Version: 0) => error_code member_assignment + error_code => INT16 + member_assignment => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>member_assignment</td><td></td></tr> +</table> +</p> +<h5>DescribeGroups API (Key: 15):</h5> + +<b>Requests:</b><br> +<p><pre>DescribeGroups Request (Version: 0) => [group_ids] + group_ids => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_ids</td><td>List of groupIds to request metadata for (an empty groupId array will return empty group metadata).</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>DescribeGroups Response (Version: 0) => [groups] + groups => error_code group_id state protocol_type protocol [members] + error_code => INT16 + group_id => STRING + state => STRING + protocol_type => STRING + protocol => STRING + members => member_id client_id client_host member_metadata member_assignment + member_id => STRING + client_id => STRING + client_host => STRING + member_metadata => BYTES + member_assignment => BYTES +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>groups</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +<tr> +<td>group_id</td><td></td></tr> +<tr> +<td>state</td><td>The current state of the group (one of: Dead, Stable, AwaitingSync, or PreparingRebalance, or empty if there is no active group)</td></tr> +<tr> +<td>protocol_type</td><td>The current group protocol type (will be empty if there is no active group)</td></tr> +<tr> +<td>protocol</td><td>The current group protocol (only provided if the group is Stable)</td></tr> +<tr> +<td>members</td><td>Current group members (only provided if the group is not Dead)</td></tr> +<tr> +<td>member_id</td><td>The memberId assigned by the coordinator</td></tr> +<tr> +<td>client_id</td><td>The client id used in the member's latest join group request</td></tr> +<tr> +<td>client_host</td><td>The client host used in the request session corresponding to the member's join group.</td></tr> +<tr> +<td>member_metadata</td><td>The metadata corresponding to the current group protocol in use (will only be present if the group is stable).</td></tr> +<tr> +<td>member_assignment</td><td>The current assignment provided by the group leader (will only be present if the group is stable).</td></tr> +</table> +</p> +<h5>ListGroups API (Key: 16):</h5> + +<b>Requests:</b><br> +<p><pre>ListGroups Request (Version: 0) => +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr></table> +</p> +<b>Responses:</b><br> +<p><pre>ListGroups Response (Version: 0) => error_code [groups] + error_code => INT16 + groups => group_id protocol_type + group_id => STRING + protocol_type => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>groups</td><td></td></tr> +<tr> +<td>group_id</td><td></td></tr> +<tr> +<td>protocol_type</td><td></td></tr> +</table> +</p> +<h5>SaslHandshake API (Key: 17):</h5> + +<b>Requests:</b><br> +<p><pre>SaslHandshake Request (Version: 0) => mechanism + mechanism => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>mechanism</td><td>SASL Mechanism chosen by the client.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>SaslHandshake Response (Version: 0) => error_code [enabled_mechanisms] + error_code => INT16 + enabled_mechanisms => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td></td></tr> +<tr> +<td>enabled_mechanisms</td><td>Array of mechanisms enabled in the server.</td></tr> +</table> +</p> +<h5>ApiVersions API (Key: 18):</h5> + +<b>Requests:</b><br> +<p><pre>ApiVersions Request (Version: 0) => +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr></table> +</p> +<b>Responses:</b><br> +<p><pre>ApiVersions Response (Version: 0) => error_code [api_versions] + error_code => INT16 + api_versions => api_key min_version max_version + api_key => INT16 + min_version => INT16 + max_version => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Error code.</td></tr> +<tr> +<td>api_versions</td><td>API versions supported by the broker.</td></tr> +<tr> +<td>api_key</td><td>API key.</td></tr> +<tr> +<td>min_version</td><td>Minimum supported version.</td></tr> +<tr> +<td>max_version</td><td>Maximum supported version.</td></tr> +</table> +</p> +<h5>CreateTopics API (Key: 19):</h5> + +<b>Requests:</b><br> +<p><pre>CreateTopics Request (Version: 0) => [create_topic_requests] timeout + create_topic_requests => topic num_partitions replication_factor [replica_assignment] [configs] + topic => STRING + num_partitions => INT32 + replication_factor => INT16 + replica_assignment => partition_id [replicas] + partition_id => INT32 + replicas => INT32 + configs => config_key config_value + config_key => STRING + config_value => STRING + timeout => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>create_topic_requests</td><td>An array of single topic creation requests. Can not have multiple entries for the same topic.</td></tr> +<tr> +<td>topic</td><td>Name for newly created topic.</td></tr> +<tr> +<td>num_partitions</td><td>Number of partitions to be created. -1 indicates unset.</td></tr> +<tr> +<td>replication_factor</td><td>Replication factor for the topic. -1 indicates unset.</td></tr> +<tr> +<td>replica_assignment</td><td>Replica assignment among kafka brokers for this topic partitions. If this is set num_partitions and replication_factor must be unset.</td></tr> +<tr> +<td>partition_id</td><td></td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that should host this partition. The first replica in the list is the preferred leader.</td></tr> +<tr> +<td>configs</td><td>Topic level configuration for topic to be set.</td></tr> +<tr> +<td>config_key</td><td>Configuration key name</td></tr> +<tr> +<td>config_value</td><td>Configuration value</td></tr> +<tr> +<td>timeout</td><td>The time in ms to wait for a topic to be completely created on the controller node. Values <= 0 will trigger topic creation and return immediately</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>CreateTopics Response (Version: 0) => [topic_error_codes] + topic_error_codes => topic error_code + topic => STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topic_error_codes</td><td>An array of per topic error codes.</td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> +<h5>DeleteTopics API (Key: 20):</h5> + +<b>Requests:</b><br> +<p><pre>DeleteTopics Request (Version: 0) => [topics] timeout + topics => STRING + timeout => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to be deleted.</td></tr> +<tr> +<td>timeout</td><td>The time in ms to wait for a topic to be completely deleted on the controller node. Values <= 0 will trigger topic deletion and return immediately</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>DeleteTopics Response (Version: 0) => [topic_error_codes] + topic_error_codes => topic error_code + topic => STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topic_error_codes</td><td>An array of per topic error codes.</td></tr> +<tr> +<td>topic</td><td></td></tr> +<tr> +<td>error_code</td><td></td></tr> +</table> +</p> + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/generated/streams_config.html ---------------------------------------------------------------------- diff --git a/0101/generated/streams_config.html b/0101/generated/streams_config.html new file mode 100644 index 0000000..2ed7226 --- /dev/null +++ b/0101/generated/streams_config.html @@ -0,0 +1,56 @@ +<table class="data-table"><tbody> +<tr> +<th>Name</th> +<th>Description</th> +<th>Type</th> +<th>Default</th> +<th>Valid Values</th> +<th>Importance</th> +</tr> +<tr> +<td>application.id</td><td>An identifier for the stream processing application. Must be unique within the Kafka cluster. It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix.</td><td>string</td><td></td><td></td><td>high</td></tr> +<tr> +<td>bootstrap.servers</td><td>A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form <code>host1:port1,host2:port2,...</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).</td><td>list</td><td></td><td></td><td>high</td></tr> +<tr> +<td>client.id</td><td>An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.</td><td>string</td><td>""</td><td></td><td>high</td></tr> +<tr> +<td>zookeeper.connect</td><td>Zookeeper connect string for Kafka topics management.</td><td>string</td><td>""</td><td></td><td>high</td></tr> +<tr> +<td>key.serde</td><td>Serializer / deserializer class for key that implements the <code>Serde</code> interface.</td><td>class</td><td>class org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td><td></td><td>medium</td></tr> +<tr> +<td>partition.grouper</td><td>Partition grouper class that implements the <code>PartitionGrouper</code> interface.</td><td>class</td><td>class org.apache.kafka.streams.processor.DefaultPartitionGrouper</td><td></td><td>medium</td></tr> +<tr> +<td>replication.factor</td><td>The replication factor for change log topics and repartition topics created by the stream processing application.</td><td>int</td><td>1</td><td></td><td>medium</td></tr> +<tr> +<td>state.dir</td><td>Directory location for state store.</td><td>string</td><td>/tmp/kafka-streams</td><td></td><td>medium</td></tr> +<tr> +<td>timestamp.extractor</td><td>Timestamp extractor class that implements the <code>TimestampExtractor</code> interface.</td><td>class</td><td>class org.apache.kafka.streams.processor.ConsumerRecordTimestampExtractor</td><td></td><td>medium</td></tr> +<tr> +<td>value.serde</td><td>Serializer / deserializer class for value that implements the <code>Serde</code> interface.</td><td>class</td><td>class org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td><td></td><td>medium</td></tr> +<tr> +<td>windowstore.changelog.additional.retention.ms</td><td>Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift. Default is 1 day</td><td>long</td><td>86400000</td><td></td><td>medium</td></tr> +<tr> +<td>application.server</td><td>A host:port pair pointing to an embedded user defined endpoint that can be used for discovering the locations of state stores within a single KafkaStreams application</td><td>string</td><td>""</td><td></td><td>low</td></tr> +<tr> +<td>buffered.records.per.partition</td><td>The maximum number of records to buffer per partition.</td><td>int</td><td>1000</td><td></td><td>low</td></tr> +<tr> +<td>cache.max.bytes.buffering</td><td>Maximum number of memory bytes to be used for buffering across all threads</td><td>long</td><td>10485760</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>commit.interval.ms</td><td>The frequency with which to save the position of the processor.</td><td>long</td><td>30000</td><td></td><td>low</td></tr> +<tr> +<td>metric.reporters</td><td>A list of classes to use as metrics reporters. Implementing the <code>MetricReporter</code> interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics.</td><td>list</td><td>[]</td><td></td><td>low</td></tr> +<tr> +<td>metrics.num.samples</td><td>The number of samples maintained to compute metrics.</td><td>int</td><td>2</td><td>[1,...]</td><td>low</td></tr> +<tr> +<td>metrics.sample.window.ms</td><td>The window of time a metrics sample is computed over.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>num.standby.replicas</td><td>The number of standby replicas for each task.</td><td>int</td><td>0</td><td></td><td>low</td></tr> +<tr> +<td>num.stream.threads</td><td>The number of threads to execute stream processing.</td><td>int</td><td>1</td><td></td><td>low</td></tr> +<tr> +<td>poll.ms</td><td>The amount of time in milliseconds to block waiting for input.</td><td>long</td><td>100</td><td></td><td>low</td></tr> +<tr> +<td>rocksdb.config.setter</td><td>A Rocks DB config setter class that implements the <code>RocksDBConfigSetter</code> interface</td><td>class</td><td>null</td><td></td><td>low</td></tr> +<tr> +<td>state.cleanup.delay.ms</td><td>The amount of time in milliseconds to wait before deleting state when a partition has migrated.</td><td>long</td><td>60000</td><td></td><td>low</td></tr> +</tbody></table> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/generated/topic_config.html ---------------------------------------------------------------------- diff --git a/0101/generated/topic_config.html b/0101/generated/topic_config.html new file mode 100644 index 0000000..eb1f081 --- /dev/null +++ b/0101/generated/topic_config.html @@ -0,0 +1,59 @@ +<table class="data-table"><tbody> +<tr> +<th>Name</th> +<th>Description</th> +<th>Type</th> +<th>Default</th> +<th>Valid Values</th> +<th>Server Default Property</th> +<th>Importance</th> +</tr> +<tr> +<td>cleanup.policy</td><td>A string that is either "delete" or "compact". This string designates the retention policy to use on old log segments. The default policy ("delete") will discard old segments when their retention time or size limit has been reached. The "compact" setting will enable <a href="#compaction">log compaction</a> on the topic.</td><td>list</td><td>[delete]</td><td>[compact, delete]</td><td>log.cleanup.policy</td><td>medium</td></tr> +<tr> +<td>compression.type</td><td>Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', lz4). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer.</td><td>string</td><td>producer</td><td>[uncompressed, snappy, lz4, gzip, producer]</td><td>compression.type</td><td>medium</td></tr> +<tr> +<td>delete.retention.ms</td><td>The amount of time to retain delete tombstone markers for <a href="#compaction">log compacted</a> topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).</td><td>long</td><td>86400000</td><td>[0,...]</td><td>log.cleaner.delete.retention.ms</td><td>medium</td></tr> +<tr> +<td>file.delete.delay.ms</td><td>The time to wait before deleting a file from the filesystem</td><td>long</td><td>60000</td><td>[0,...]</td><td>log.segment.delete.delay.ms</td><td>medium</td></tr> +<tr> +<td>flush.messages</td><td>This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. This setting can be overridden on a per-topic basis (see <a href="#topic-config">the per-topic configuration section</a>).</td><td>long</td><td>9223372036854775807</td><td>[0,...]</td><td>log.flush.interval.messages</td><td>medium</td></tr> +<tr> +<td>flush.ms</td><td>This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.</td><td>long</td><td>9223372036854775807</td><td>[0,...]</td><td>log.flush.interval.ms</td><td>medium</td></tr> +<tr> +<td>follower.replication.throttled.replicas</td><td>A list of replicas for which log replication should be throttled on the follower side. The list should describe a set of replicas in the form [PartitionId]:[BrokerId],[PartitionId]:[BrokerId]:... or alternatively the wildcard '*' can be used to throttle all replicas for this topic.</td><td>list</td><td>[]</td><td>kafka.server.ThrottledReplicaListValidator$@535367a7</td><td>follower.replication.throttled.replicas</td><td>medium</td></tr> +<tr> +<td>index.interval.bytes</td><td>This setting controls how frequently Kafka adds an index entry to it's offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.</td><td>int</td><td>4096</td><td>[0,...]</td><td>log.index.interval.bytes</td><td>medium</td></tr> +<tr> +<td>leader.replication.throttled.replicas</td><td>A list of replicas for which log replication should be throttled on the leader side. The list should describe a set of replicas in the form [PartitionId]:[BrokerId],[PartitionId]:[BrokerId]:... or alternatively the wildcard '*' can be used to throttle all replicas for this topic.</td><td>list</td><td>[]</td><td>kafka.server.ThrottledReplicaListValidator$@535367a7</td><td>leader.replication.throttled.replicas</td><td>medium</td></tr> +<tr> +<td>max.message.bytes</td><td>This is largest message size Kafka will allow to be appended. Note that if you increase this size you must also increase your consumer's fetch size so they can fetch messages this large.</td><td>int</td><td>1000012</td><td>[0,...]</td><td>message.max.bytes</td><td>medium</td></tr> +<tr> +<td>message.format.version</td><td>Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand.</td><td>string</td><td>0.10.1-IV2</td><td></td><td>log.message.format.version</td><td>medium</td></tr> +<tr> +<td>message.timestamp.difference.max.ms</td><td>The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.</td><td>long</td><td>9223372036854775807</td><td>[0,...]</td><td>log.message.timestamp.difference.max.ms</td><td>medium</td></tr> +<tr> +<td>message.timestamp.type</td><td>Define whether the timestamp in the message is message create time or log append time. The value should be either `CreateTime` or `LogAppendTime`</td><td>string</td><td>CreateTime</td><td></td><td>log.message.timestamp.type</td><td>medium</td></tr> +<tr> +<td>min.cleanable.dirty.ratio</td><td>This configuration controls how frequently the log compactor will attempt to clean the log (assuming <a href="#compaction">log compaction</a> is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log.</td><td>double</td><td>0.5</td><td>[0,...,1]</td><td>log.cleaner.min.cleanable.ratio</td><td>medium</td></tr> +<tr> +<td>min.compaction.lag.ms</td><td>The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.</td><td>long</td><td>0</td><td>[0,...]</td><td>log.cleaner.min.compaction.lag.ms</td><td>medium</td></tr> +<tr> +<td>min.insync.replicas</td><td>When a producer sets acks to "all" (or "-1"), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend).<br>When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of "all". This will ensure that the producer raises an exception if a majority of replicas do not receive a write.</td><td>int</td><td>1</td><td>[1,...]</td><td>min.insync.replicas</td><td>medium</td></tr> +<tr> +<td>preallocate</td><td>Should pre allocate file when create new segment?</td><td>boolean</td><td>false</td><td></td><td>log.preallocate</td><td>medium</td></tr> +<tr> +<td>retention.bytes</td><td>This configuration controls the maximum size a log can grow to before we will discard old log segments to free up space if we are using the "delete" retention policy. By default there is no size limit only a time limit.</td><td>long</td><td>-1</td><td></td><td>log.retention.bytes</td><td>medium</td></tr> +<tr> +<td>retention.ms</td><td>This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the "delete" retention policy. This represents an SLA on how soon consumers must read their data.</td><td>long</td><td>604800000</td><td></td><td>log.retention.ms</td><td>medium</td></tr> +<tr> +<td>segment.bytes</td><td>This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention.</td><td>int</td><td>1073741824</td><td>[14,...]</td><td>log.segment.bytes</td><td>medium</td></tr> +<tr> +<td>segment.index.bytes</td><td>This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.</td><td>int</td><td>10485760</td><td>[0,...]</td><td>log.index.size.max.bytes</td><td>medium</td></tr> +<tr> +<td>segment.jitter.ms</td><td>The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling</td><td>long</td><td>0</td><td>[0,...]</td><td>log.roll.jitter.ms</td><td>medium</td></tr> +<tr> +<td>segment.ms</td><td>This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data.</td><td>long</td><td>604800000</td><td>[0,...]</td><td>log.roll.ms</td><td>medium</td></tr> +<tr> +<td>unclean.leader.election.enable</td><td>Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss</td><td>boolean</td><td>true</td><td></td><td>unclean.leader.election.enable</td><td>medium</td></tr> +</tbody></table> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/consumer-groups.png ---------------------------------------------------------------------- diff --git a/0101/images/consumer-groups.png b/0101/images/consumer-groups.png new file mode 100644 index 0000000..16fe293 Binary files /dev/null and b/0101/images/consumer-groups.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/kafka_log.png ---------------------------------------------------------------------- diff --git a/0101/images/kafka_log.png b/0101/images/kafka_log.png new file mode 100644 index 0000000..75abd96 Binary files /dev/null and b/0101/images/kafka_log.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/kafka_multidc.png ---------------------------------------------------------------------- diff --git a/0101/images/kafka_multidc.png b/0101/images/kafka_multidc.png new file mode 100644 index 0000000..7bc56f4 Binary files /dev/null and b/0101/images/kafka_multidc.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/kafka_multidc_complex.png ---------------------------------------------------------------------- diff --git a/0101/images/kafka_multidc_complex.png b/0101/images/kafka_multidc_complex.png new file mode 100644 index 0000000..ab88deb Binary files /dev/null and b/0101/images/kafka_multidc_complex.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/log_anatomy.png ---------------------------------------------------------------------- diff --git a/0101/images/log_anatomy.png b/0101/images/log_anatomy.png new file mode 100644 index 0000000..a649499 Binary files /dev/null and b/0101/images/log_anatomy.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/log_cleaner_anatomy.png ---------------------------------------------------------------------- diff --git a/0101/images/log_cleaner_anatomy.png b/0101/images/log_cleaner_anatomy.png new file mode 100644 index 0000000..fb425b0 Binary files /dev/null and b/0101/images/log_cleaner_anatomy.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/log_compaction.png ---------------------------------------------------------------------- diff --git a/0101/images/log_compaction.png b/0101/images/log_compaction.png new file mode 100644 index 0000000..4e4a833 Binary files /dev/null and b/0101/images/log_compaction.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/mirror-maker.png ---------------------------------------------------------------------- diff --git a/0101/images/mirror-maker.png b/0101/images/mirror-maker.png new file mode 100644 index 0000000..8f76b1f Binary files /dev/null and b/0101/images/mirror-maker.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/producer_consumer.png ---------------------------------------------------------------------- diff --git a/0101/images/producer_consumer.png b/0101/images/producer_consumer.png new file mode 100644 index 0000000..4b10cc9 Binary files /dev/null and b/0101/images/producer_consumer.png differ http://git-wip-us.apache.org/repos/asf/kafka-site/blob/ed0bb0d9/0101/images/tracking_high_level.png ---------------------------------------------------------------------- diff --git a/0101/images/tracking_high_level.png b/0101/images/tracking_high_level.png new file mode 100644 index 0000000..b643230 Binary files /dev/null and b/0101/images/tracking_high_level.png differ
