http://git-wip-us.apache.org/repos/asf/kafka-site/blob/14ffd37c/090/generated/producer_config.html ---------------------------------------------------------------------- diff --git a/090/generated/producer_config.html b/090/generated/producer_config.html new file mode 100644 index 0000000..9d97e86 --- /dev/null +++ b/090/generated/producer_config.html @@ -0,0 +1,104 @@ +<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>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>key.serializer</td><td>Serializer class for key that implements the <code>Serializer</code> interface.</td><td>class</td><td></td><td></td><td>high</td></tr> +<tr> +<td>value.serializer</td><td>Serializer class for value that implements the <code>Serializer</code> interface.</td><td>class</td><td></td><td></td><td>high</td></tr> +<tr> +<td>acks</td><td>The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are common: <ul> <li><code>acks=0</code> If set to zero then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the <code>retries</code> configuration will not take effect (as the client won't generally know of any failures). The offset given back for each record will always be set to -1. <li><code>acks=1</code> This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record wil l be lost. <li><code>acks=all</code> This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee.</td><td>string</td><td>1</td><td>[all, -1, 0, 1]</td><td>high</td></tr> +<tr> +<td>buffer.memory</td><td>The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will either block or throw an exception based on the preference specified by <code>block.on.buffer.full</code>. <p>This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests.</td><td>long</td><td>33554432</td><td>[0,...]</td><td>high</td></tr> +<tr> +<td>compression.type</td><td>The compression type for all data generated by the producer. The default is none (i.e. no compression). Valid values are <code>none</code>, <code>gzip</code>, <code>snappy</code>, or <code>lz4</code>. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).</td><td>string</td><td>none</td><td></td><td>high</td></tr> +<tr> +<td>retries</td><td>Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error. Note that this retry is no different than if the client resent the record upon receiving the error. Allowing retries will potentially change the ordering of records because if two records are sent to a single partition, and the first fails and is retried but the second succeeds, then the second record may appear first.</td><td>int</td><td>0</td><td>[0,...,2147483647]</td><td>high</td></tr> +<tr> +<td>ssl.key.password</td><td>The password of the private key in the key store file. This is optional for client.</td><td>password</td><td>null</td><td></td><td>high</td></tr> +<tr> +<td>ssl.keystore.location</td><td>The location of the key store file. This is optional for client and can be used for two-way authentication for client.</td><td>string</td><td>null</td><td></td><td>high</td></tr> +<tr> +<td>ssl.keystore.password</td><td>The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured. </td><td>password</td><td>null</td><td></td><td>high</td></tr> +<tr> +<td>ssl.truststore.location</td><td>The location of the trust store file. </td><td>string</td><td>null</td><td></td><td>high</td></tr> +<tr> +<td>ssl.truststore.password</td><td>The password for the trust store file. </td><td>password</td><td>null</td><td></td><td>high</td></tr> +<tr> +<td>batch.size</td><td>The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. <p>No attempt will be made to batch records larger than this size. <p>Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. <p>A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records.</td><td>int</td><td>16384</td><td>[0,...]</td><td>medium</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>medium</td></tr> +<tr> +<td>connections.max.idle.ms</td><td>Close idle connections after the number of milliseconds specified by this config.</td><td>long</td><td>540000</td><td></td><td>medium</td></tr> +<tr> +<td>linger.ms</td><td>The producer groups together any records that arrive in between request transmissions into a single batched request. Normally this occurs only under load when records arrive faster than they can be sent out. However in some circumstances the client may want to reduce the number of requests even under moderate load. This setting accomplishes this by adding a small amount of artificial delay—that is, rather than immediately sending out a record the producer will wait for up to the given delay to allow other records to be sent so that the sends can be batched together. This can be thought of as analogous to Nagle's algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get <code>batch.size</code> worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e. no delay). Setting <code>linger.ms=5</code>, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absense of load.</td><td>long</td><td>0</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>max.block.ms</td><td>The configuration controls how long {@link KafkaProducer#send()} and {@link KafkaProducer#partitionsFor} will block.These methods can be blocked either because the buffer is full or metadata unavailable.Blocking in the user-supplied serializers or partitioner will not be counted against this timeout.</td><td>long</td><td>60000</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>max.request.size</td><td>The maximum size of a request. This is also effectively a cap on the maximum record size. Note that the server has its own cap on record size which may be different from this. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.</td><td>int</td><td>1048576</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>partitioner.class</td><td>Partitioner class that implements the <code>Partitioner</code> interface.</td><td>class</td><td>class org.apache.kafka.clients.producer.internals.DefaultPartitioner</td><td></td><td>medium</td></tr> +<tr> +<td>receive.buffer.bytes</td><td>The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.</td><td>int</td><td>32768</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>request.timeout.ms</td><td>The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted.</td><td>int</td><td>30000</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>sasl.kerberos.service.name</td><td>The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config.</td><td>string</td><td>null</td><td></td><td>medium</td></tr> +<tr> +<td>security.protocol</td><td>Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.</td><td>string</td><td>PLAINTEXT</td><td></td><td>medium</td></tr> +<tr> +<td>send.buffer.bytes</td><td>The size of the TCP send buffer (SO_SNDBUF) to use when sending data.</td><td>int</td><td>131072</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>ssl.enabled.protocols</td><td>The list of protocols enabled for SSL connections.</td><td>list</td><td>[TLSv1.2, TLSv1.1, TLSv1]</td><td></td><td>medium</td></tr> +<tr> +<td>ssl.keystore.type</td><td>The file format of the key store file. This is optional for client.</td><td>string</td><td>JKS</td><td></td><td>medium</td></tr> +<tr> +<td>ssl.protocol</td><td>The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities.</td><td>string</td><td>TLS</td><td></td><td>medium</td></tr> +<tr> +<td>ssl.provider</td><td>The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.</td><td>string</td><td>null</td><td></td><td>medium</td></tr> +<tr> +<td>ssl.truststore.type</td><td>The file format of the trust store file.</td><td>string</td><td>JKS</td><td></td><td>medium</td></tr> +<tr> +<td>timeout.ms</td><td>The configuration controls the maximum amount of time the server will wait for acknowledgments from followers to meet the acknowledgment requirements the producer has specified with the <code>acks</code> configuration. If the requested number of acknowledgments are not met when the timeout elapses an error will be returned. This timeout is measured on the server side and does not include the network latency of the request.</td><td>int</td><td>30000</td><td>[0,...]</td><td>medium</td></tr> +<tr> +<td>block.on.buffer.full</td><td>When our memory buffer is exhausted we must either stop accepting new records (block) or throw errors. By default this setting is true and we block, however in some scenarios blocking is not desirable and it is better to immediately give an error. Setting this to <code>false</code> will accomplish that: the producer will throw a BufferExhaustedException if a recrord is sent and the buffer space is full.</td><td>boolean</td><td>false</td><td></td><td>low</td></tr> +<tr> +<td>max.in.flight.requests.per.connection</td><td>The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled).</td><td>int</td><td>5</td><td>[1,...]</td><td>low</td></tr> +<tr> +<td>metadata.fetch.timeout.ms</td><td>The first time data is sent to a topic we must fetch metadata about that topic to know which servers host the topic's partitions. This fetch to succeed before throwing an exception back to the client.</td><td>long</td><td>60000</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>metadata.max.age.ms</td><td>The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.</td><td>long</td><td>300000</td><td>[0,...]</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 number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>reconnect.backoff.ms</td><td>The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.</td><td>long</td><td>50</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>retry.backoff.ms</td><td>The amount of time to wait before attempting to retry a failed fetch request to a given topic partition. This avoids repeated fetching-and-failing in a tight loop.</td><td>long</td><td>100</td><td>[0,...]</td><td>low</td></tr> +<tr> +<td>sasl.kerberos.kinit.cmd</td><td>Kerberos kinit command path.</td><td>string</td><td>/usr/bin/kinit</td><td></td><td>low</td></tr> +<tr> +<td>sasl.kerberos.min.time.before.relogin</td><td>Login thread sleep time between refresh attempts.</td><td>long</td><td>60000</td><td></td><td>low</td></tr> +<tr> +<td>sasl.kerberos.ticket.renew.jitter</td><td>Percentage of random jitter added to the renewal time.</td><td>double</td><td>0.05</td><td></td><td>low</td></tr> +<tr> +<td>sasl.kerberos.ticket.renew.window.factor</td><td>Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket.</td><td>double</td><td>0.8</td><td></td><td>low</td></tr> +<tr> +<td>ssl.cipher.suites</td><td>A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol.By default all the available cipher suites are supported.</td><td>list</td><td>null</td><td></td><td>low</td></tr> +<tr> +<td>ssl.endpoint.identification.algorithm</td><td>The endpoint identification algorithm to validate server hostname using server certificate. </td><td>string</td><td>null</td><td></td><td>low</td></tr> +<tr> +<td>ssl.keymanager.algorithm</td><td>The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.</td><td>string</td><td>SunX509</td><td></td><td>low</td></tr> +<tr> +<td>ssl.trustmanager.algorithm</td><td>The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.</td><td>string</td><td>PKIX</td><td></td><td>low</td></tr> +</tbody></table>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/14ffd37c/090/generated/protocol_api_keys.html ---------------------------------------------------------------------- diff --git a/090/generated/protocol_api_keys.html b/090/generated/protocol_api_keys.html new file mode 100644 index 0000000..6d4d827 --- /dev/null +++ b/090/generated/protocol_api_keys.html @@ -0,0 +1,39 @@ +<table class="data-table"><tbody> +<tr><th>Name</th> +<th>Key</th> +</tr><tr> +<td>Produce</td><td>0</td></tr> +<tr> +<td>Fetch</td><td>1</td></tr> +<tr> +<td>Offsets</td><td>2</td></tr> +<tr> +<td>Metadata</td><td>3</td></tr> +<tr> +<td>LeaderAndIsr</td><td>4</td></tr> +<tr> +<td>StopReplica</td><td>5</td></tr> +<tr> +<td>UpdateMetadata</td><td>6</td></tr> +<tr> +<td>ControlledShutdown</td><td>7</td></tr> +<tr> +<td>OffsetCommit</td><td>8</td></tr> +<tr> +<td>OffsetFetch</td><td>9</td></tr> +<tr> +<td>GroupCoordinator</td><td>10</td></tr> +<tr> +<td>JoinGroup</td><td>11</td></tr> +<tr> +<td>Heartbeat</td><td>12</td></tr> +<tr> +<td>LeaveGroup</td><td>13</td></tr> +<tr> +<td>SyncGroup</td><td>14</td></tr> +<tr> +<td>DescribeGroups</td><td>15</td></tr> +<tr> +<td>ListGroups</td><td>16</td></tr> +</table> + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/14ffd37c/090/generated/protocol_errors.html ---------------------------------------------------------------------- diff --git a/090/generated/protocol_errors.html b/090/generated/protocol_errors.html new file mode 100644 index 0000000..a0d274e --- /dev/null +++ b/090/generated/protocol_errors.html @@ -0,0 +1,40 @@ +<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>The message contents does not match the message CRC or the message 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>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 an acceptable range.</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>Topic authorization failed.</td></tr> +<tr><td>GROUP_AUTHORIZATION_FAILED</td><td>30</td><td>False</td><td>Group authorization failed.</td></tr> +<tr><td>CLUSTER_AUTHORIZATION_FAILED</td><td>31</td><td>False</td><td>Cluster authorization failed.</td></tr> +</table> + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/14ffd37c/090/generated/protocol_messages.html ---------------------------------------------------------------------- diff --git a/090/generated/protocol_messages.html b/090/generated/protocol_messages.html new file mode 100644 index 0000000..c3b0725 --- /dev/null +++ b/090/generated/protocol_messages.html @@ -0,0 +1,1192 @@ +<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 nodes that should replicate the produce before returning. -1 indicates 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 nodes that should replicate the produce before returning. -1 indicates 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> +<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> +<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> +<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> +<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 +</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> +<h5>Metadata API (Key: 3):</h5> + +<b>Requests:</b><br> +<p><pre>Metadata Request (Version: 0) => [topics] +</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> +<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 +</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> +<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 + zk_version => 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 => INT8 + 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 + zk_version => 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 + zk_version => 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> +<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> +<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 => 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 => 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 => 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 => 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 => 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> +<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> +<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] +</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 the 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> + http://git-wip-us.apache.org/repos/asf/kafka-site/blob/14ffd37c/090/kafka_config.html ---------------------------------------------------------------------- diff --git a/090/kafka_config.html b/090/kafka_config.html deleted file mode 100644 index efefeb9..0000000 --- a/090/kafka_config.html +++ /dev/null @@ -1,270 +0,0 @@ -<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>zookeeper.connect</td><td>Zookeeper host string</td><td>string</td><td></td><td></td><td>high</td></tr> -<tr> -<td>advertised.host.name</td><td>Hostname to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, it will use the value for "host.name" if configured. Otherwise it will use the value returned from java.net.InetAddress.getCanonicalHostName().</td><td>string</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>advertised.listeners</td><td>Listeners to publish to ZooKeeper for clients to use, if different than the listeners above. In IaaS environments, this may need to be different from the interface to which the broker binds. If this is not set, the value for "listeners" will be used.</td><td>string</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>advertised.port</td><td>The port to publish to ZooKeeper for clients to use. In IaaS environments, this may need to be different from the port to which the broker binds. If this is not set, it will publish the same port that the broker binds to.</td><td>int</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>auto.create.topics.enable</td><td>Enable auto creation of topic on the server</td><td>boolean</td><td>true</td><td></td><td>high</td></tr> -<tr> -<td>auto.leader.rebalance.enable</td><td>Enables auto leader balancing. A background thread checks and triggers leader balance if required at regular intervals</td><td>boolean</td><td>true</td><td></td><td>high</td></tr> -<tr> -<td>background.threads</td><td>The number of threads to use for various background processing tasks</td><td>int</td><td>10</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>broker.id</td><td>The broker id for this server. To avoid conflicts between zookeeper generated brokerId and user's config.brokerId added MaxReservedBrokerId and zookeeper sequence starts from MaxReservedBrokerId + 1.</td><td>int</td><td>-1</td><td></td><td>high</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></td><td>high</td></tr> -<tr> -<td>delete.topic.enable</td><td>Enables delete topic. Delete topic through the admin tool will have no effect if this config is turned off</td><td>boolean</td><td>false</td><td></td><td>high</td></tr> -<tr> -<td>host.name</td><td>hostname of broker. If this is set, it will only bind to this address. If this is not set, it will bind to all interfaces</td><td>string</td><td>""</td><td></td><td>high</td></tr> -<tr> -<td>leader.imbalance.check.interval.seconds</td><td>The frequency with which the partition rebalance check is triggered by the controller</td><td>long</td><td>300</td><td></td><td>high</td></tr> -<tr> -<td>leader.imbalance.per.broker.percentage</td><td>The ratio of leader imbalance allowed per broker. The controller would trigger a leader balance if it goes above this value per broker. The value is specified in percentage.</td><td>int</td><td>10</td><td></td><td>high</td></tr> -<tr> -<td>listeners</td><td>Listener List - Comma-separated list of URIs we will listen on and their protocols. - Specify hostname as 0.0.0.0 to bind to all interfaces. - Leave hostname empty to bind to default interface. - Examples of legal listener lists: - PLAINTEXT://myhost:9092,TRACE://:9091 - PLAINTEXT://0.0.0.0:9092, TRACE://localhost:9093 -</td><td>string</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.dir</td><td>The directory in which the log data is kept (supplemental for log.dirs property)</td><td>string</td><td>/tmp/kafka-logs</td><td></td><td>high</td></tr> -<tr> -<td>log.dirs</td><td>The directories in which the log data is kept. If not set, the value in log.dir is used</td><td>string</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.flush.interval.messages</td><td>The number of messages accumulated on a log partition before messages are flushed to disk </td><td>long</td><td>9223372036854775807</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>log.flush.interval.ms</td><td>The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used</td><td>long</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.flush.offset.checkpoint.interval.ms</td><td>The frequency with which we update the persistent record of the last flush which acts as the log recovery point</td><td>int</td><td>60000</td><td>[0,...]</td><td>high</td></tr> -<tr> -<td>log.flush.scheduler.interval.ms</td><td>The frequency in ms that the log flusher checks whether any log needs to be flushed to disk</td><td>long</td><td>9223372036854775807</td><td></td><td>high</td></tr> -<tr> -<td>log.retention.bytes</td><td>The maximum size of the log before deleting it</td><td>long</td><td>-1</td><td></td><td>high</td></tr> -<tr> -<td>log.retention.hours</td><td>The number of hours to keep a log file before deleting it (in hours), tertiary to log.retention.ms property</td><td>int</td><td>168</td><td></td><td>high</td></tr> -<tr> -<td>log.retention.minutes</td><td>The number of minutes to keep a log file before deleting it (in minutes), secondary to log.retention.ms property. If not set, the value in log.retention.hours is used</td><td>int</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.retention.ms</td><td>The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used</td><td>long</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.roll.hours</td><td>The maximum time before a new log segment is rolled out (in hours), secondary to log.roll.ms property</td><td>int</td><td>168</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>log.roll.jitter.hours</td><td>The maximum jitter to subtract from logRollTimeMillis (in hours), secondary to log.roll.jitter.ms property</td><td>int</td><td>0</td><td>[0,...]</td><td>high</td></tr> -<tr> -<td>log.roll.jitter.ms</td><td>The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used</td><td>long</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.roll.ms</td><td>The maximum time before a new log segment is rolled out (in milliseconds). If not set, the value in log.roll.hours is used</td><td>long</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>log.segment.bytes</td><td>The maximum size of a single log file</td><td>int</td><td>1073741824</td><td>[14,...]</td><td>high</td></tr> -<tr> -<td>log.segment.delete.delay.ms</td><td>The amount of time to wait before deleting a file from the filesystem</td><td>long</td><td>60000</td><td>[0,...]</td><td>high</td></tr> -<tr> -<td>message.max.bytes</td><td>The maximum size of message that the server can receive</td><td>int</td><td>1000012</td><td>[0,...]</td><td>high</td></tr> -<tr> -<td>min.insync.replicas</td><td>define the minimum number of replicas in ISR needed to satisfy a produce request with required.acks=-1 (or all)</td><td>int</td><td>1</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>num.io.threads</td><td>The number of io threads that the server uses for carrying out network requests</td><td>int</td><td>8</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>num.network.threads</td><td>the number of network threads that the server uses for handling network requests</td><td>int</td><td>3</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>num.recovery.threads.per.data.dir</td><td>The number of threads per data directory to be used for log recovery at startup and flushing at shutdown</td><td>int</td><td>1</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>num.replica.fetchers</td><td>Number of fetcher threads used to replicate messages from a source broker. Increasing this value can increase the degree of I/O parallelism in the follower broker.</td><td>int</td><td>1</td><td></td><td>high</td></tr> -<tr> -<td>offset.metadata.max.bytes</td><td>The maximum size for a metadata entry associated with an offset commit</td><td>int</td><td>4096</td><td></td><td>high</td></tr> -<tr> -<td>offsets.commit.required.acks</td><td>The required acks before the commit can be accepted. In general, the default (-1) should not be overridden</td><td>short</td><td>-1</td><td></td><td>high</td></tr> -<tr> -<td>offsets.commit.timeout.ms</td><td>Offset commit will be delayed until all replicas for the offsets topic receive the commit or this timeout is reached. This is similar to the producer request timeout.</td><td>int</td><td>5000</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.load.buffer.size</td><td>Batch size for reading from the offsets segments when loading offsets into the cache.</td><td>int</td><td>5242880</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.retention.check.interval.ms</td><td>Frequency at which to check for stale offsets</td><td>long</td><td>600000</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.retention.minutes</td><td>Log retention window in minutes for offsets topic</td><td>int</td><td>1440</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.topic.compression.codec</td><td>Compression codec for the offsets topic - compression may be used to achieve "atomic" commits</td><td>int</td><td>0</td><td></td><td>high</td></tr> -<tr> -<td>offsets.topic.num.partitions</td><td>The number of partitions for the offset commit topic (should not change after deployment)</td><td>int</td><td>50</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.topic.replication.factor</td><td>The replication factor for the offsets topic (set higher to ensure availability). To ensure that the effective replication factor of the offsets topic is the configured value, the number of alive brokers has to be at least the replication factor at the time of the first request for the offsets topic. If not, either the offsets topic creation will fail or it will get a replication factor of min(alive brokers, configured replication factor)</td><td>short</td><td>3</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>offsets.topic.segment.bytes</td><td>The offsets topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads</td><td>int</td><td>104857600</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>port</td><td>the port to listen and accept connections on</td><td>int</td><td>9092</td><td></td><td>high</td></tr> -<tr> -<td>queued.max.requests</td><td>The number of queued requests allowed before blocking the network threads</td><td>int</td><td>500</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>quota.consumer.default</td><td>Any consumer distinguished by clientId/consumer group will get throttled if it fetches more bytes than this value per-second</td><td>long</td><td>9223372036854775807</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>quota.producer.default</td><td>Any producer distinguished by clientId will get throttled if it produces more bytes than this value per-second</td><td>long</td><td>9223372036854775807</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>replica.fetch.max.bytes</td><td>The number of byes of messages to attempt to fetch</td><td>int</td><td>1048576</td><td></td><td>high</td></tr> -<tr> -<td>replica.fetch.min.bytes</td><td>Minimum bytes expected for each fetch response. If not enough bytes, wait up to replicaMaxWaitTimeMs</td><td>int</td><td>1</td><td></td><td>high</td></tr> -<tr> -<td>replica.fetch.wait.max.ms</td><td>max wait time for each fetcher request issued by follower replicas. This value should always be less than the replica.lag.time.max.ms at all times to prevent frequent shrinking of ISR for low throughput topics</td><td>int</td><td>500</td><td></td><td>high</td></tr> -<tr> -<td>replica.high.watermark.checkpoint.interval.ms</td><td>The frequency with which the high watermark is saved out to disk</td><td>long</td><td>5000</td><td></td><td>high</td></tr> -<tr> -<td>replica.lag.time.max.ms</td><td>If a follower hasn't sent any fetch requests or hasn't consumed up to the leaders log end offset for at least this time, the leader will remove the follower from isr</td><td>long</td><td>10000</td><td></td><td>high</td></tr> -<tr> -<td>replica.socket.receive.buffer.bytes</td><td>The socket receive buffer for network requests</td><td>int</td><td>65536</td><td></td><td>high</td></tr> -<tr> -<td>replica.socket.timeout.ms</td><td>The socket timeout for network requests. Its value should be at least replica.fetch.wait.max.ms</td><td>int</td><td>30000</td><td></td><td>high</td></tr> -<tr> -<td>request.timeout.ms</td><td>The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted.</td><td>int</td><td>30000</td><td></td><td>high</td></tr> -<tr> -<td>socket.receive.buffer.bytes</td><td>The SO_RCVBUF buffer of the socket sever sockets</td><td>int</td><td>102400</td><td></td><td>high</td></tr> -<tr> -<td>socket.request.max.bytes</td><td>The maximum number of bytes in a socket request</td><td>int</td><td>104857600</td><td>[1,...]</td><td>high</td></tr> -<tr> -<td>socket.send.buffer.bytes</td><td>The SO_SNDBUF buffer of the socket sever sockets</td><td>int</td><td>102400</td><td></td><td>high</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>high</td></tr> -<tr> -<td>zookeeper.connection.timeout.ms</td><td>The max time that the client waits to establish a connection to zookeeper. If not set, the value in zookeeper.session.timeout.ms is used</td><td>int</td><td>null</td><td></td><td>high</td></tr> -<tr> -<td>zookeeper.session.timeout.ms</td><td>Zookeeper session timeout</td><td>int</td><td>6000</td><td></td><td>high</td></tr> -<tr> -<td>zookeeper.set.acl</td><td>Set client to use secure ACLs</td><td>boolean</td><td>false</td><td></td><td>high</td></tr> -<tr> -<td>broker.id.generation.enable</td><td>Enable automatic broker id generation on the server? When enabled the value configured for reserved.broker.max.id should be reviewed.</td><td>boolean</td><td>true</td><td></td><td>medium</td></tr> -<tr> -<td>connections.max.idle.ms</td><td>Idle connections timeout: the server socket processor threads close the connections that idle more than this</td><td>long</td><td>600000</td><td></td><td>medium</td></tr> -<tr> -<td>controlled.shutdown.enable</td><td>Enable controlled shutdown of the server</td><td>boolean</td><td>true</td><td></td><td>medium</td></tr> -<tr> -<td>controlled.shutdown.max.retries</td><td>Controlled shutdown can fail for multiple reasons. This determines the number of retries when such failure happens</td><td>int</td><td>3</td><td></td><td>medium</td></tr> -<tr> -<td>controlled.shutdown.retry.backoff.ms</td><td>Before each retry, the system needs time to recover from the state that caused the previous failure (Controller fail over, replica lag etc). This config determines the amount of time to wait before retrying.</td><td>long</td><td>5000</td><td></td><td>medium</td></tr> -<tr> -<td>controller.socket.timeout.ms</td><td>The socket timeout for controller-to-broker channels</td><td>int</td><td>30000</td><td></td><td>medium</td></tr> -<tr> -<td>default.replication.factor</td><td>default replication factors for automatically created topics</td><td>int</td><td>1</td><td></td><td>medium</td></tr> -<tr> -<td>fetch.purgatory.purge.interval.requests</td><td>The purge interval (in number of requests) of the fetch request purgatory</td><td>int</td><td>1000</td><td></td><td>medium</td></tr> -<tr> -<td>group.max.session.timeout.ms</td><td>The maximum allowed session timeout for registered consumers</td><td>int</td><td>30000</td><td></td><td>medium</td></tr> -<tr> -<td>group.min.session.timeout.ms</td><td>The minimum allowed session timeout for registered consumers</td><td>int</td><td>6000</td><td></td><td>medium</td></tr> -<tr> -<td>inter.broker.protocol.version</td><td>Specify which version of the inter-broker protocol will be used. - This is typically bumped after all brokers were upgraded to a new version. - Example of some valid values are: 0.8.0, 0.8.1, 0.8.1.1, 0.8.2, 0.8.2.0, 0.8.2.1, 0.9.0.0, 0.9.0.1 Check ApiVersion for the full list.</td><td>string</td><td>0.9.0.X</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.backoff.ms</td><td>The amount of time to sleep when there are no logs to clean</td><td>long</td><td>15000</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>log.cleaner.dedupe.buffer.size</td><td>The total memory used for log deduplication across all cleaner threads</td><td>long</td><td>134217728</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.delete.retention.ms</td><td>How long are delete records retained?</td><td>long</td><td>86400000</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.enable</td><td>Enable the log cleaner process to run on the server? Should be enabled if using any topics with a cleanup.policy=compact including the internal offsets topic. If disabled those topics will not be compacted and continually grow in size.</td><td>boolean</td><td>true</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.io.buffer.load.factor</td><td>Log cleaner dedupe buffer load factor. The percentage full the dedupe buffer can become. A higher value will allow more log to be cleaned at once but will lead to more hash collisions</td><td>double</td><td>0.9</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.io.buffer.size</td><td>The total memory used for log cleaner I/O buffers across all cleaner threads</td><td>int</td><td>524288</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>log.cleaner.io.max.bytes.per.second</td><td>The log cleaner will be throttled so that the sum of its read and write i/o will be less than this value on average</td><td>double</td><td>1.7976931348623157E308</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.min.cleanable.ratio</td><td>The minimum ratio of dirty log to total log for a log to eligible for cleaning</td><td>double</td><td>0.5</td><td></td><td>medium</td></tr> -<tr> -<td>log.cleaner.threads</td><td>The number of background threads to use for log cleaning</td><td>int</td><td>1</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>log.cleanup.policy</td><td>The default cleanup policy for segments beyond the retention window, must be either "delete" or "compact"</td><td>string</td><td>delete</td><td>[compact, delete]</td><td>medium</td></tr> -<tr> -<td>log.index.interval.bytes</td><td>The interval with which we add an entry to the offset index</td><td>int</td><td>4096</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>log.index.size.max.bytes</td><td>The maximum size in bytes of the offset index</td><td>int</td><td>10485760</td><td>[4,...]</td><td>medium</td></tr> -<tr> -<td>log.preallocate</td><td>Should pre allocate file when create new segment? If you are using Kafka on Windows, you probably need to set it to true.</td><td>boolean</td><td>false</td><td></td><td>medium</td></tr> -<tr> -<td>log.retention.check.interval.ms</td><td>The frequency in milliseconds that the log cleaner checks whether any log is eligible for deletion</td><td>long</td><td>300000</td><td>[1,...]</td><td>medium</td></tr> -<tr> -<td>max.connections.per.ip</td><td>The maximum number of connections we allow from each ip address</td><td>int</td><td>2147483647</td><td>[1,...]</td><td>medium</td></tr> -<tr> -<td>max.connections.per.ip.overrides</td><td>Per-ip or hostname overrides to the default maximum number of connections</td><td>string</td><td>""</td><td></td><td>medium</td></tr> -<tr> -<td>num.partitions</td><td>The default number of log partitions per topic</td><td>int</td><td>1</td><td>[1,...]</td><td>medium</td></tr> -<tr> -<td>principal.builder.class</td><td>The fully qualified name of a class that implements the PrincipalBuilder interface, which is currently used to build the Principal for connections with the SSL SecurityProtocol.</td><td>class</td><td>class org.apache.kafka.common.security.auth.DefaultPrincipalBuilder</td><td></td><td>medium</td></tr> -<tr> -<td>producer.purgatory.purge.interval.requests</td><td>The purge interval (in number of requests) of the producer request purgatory</td><td>int</td><td>1000</td><td></td><td>medium</td></tr> -<tr> -<td>replica.fetch.backoff.ms</td><td>The amount of time to sleep when fetch partition error occurs.</td><td>int</td><td>1000</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>reserved.broker.max.id</td><td>Max number that can be used for a broker.id</td><td>int</td><td>1000</td><td>[0,...]</td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.kinit.cmd</td><td>Kerberos kinit command path.</td><td>string</td><td>/usr/bin/kinit</td><td></td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.min.time.before.relogin</td><td>Login thread sleep time between refresh attempts.</td><td>long</td><td>60000</td><td></td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.principal.to.local.rules</td><td>A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. For more details on the format please see <a href="#security_authz"> security authorization and acls</a>.</td><td>list</td><td>[DEFAULT]</td><td></td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.service.name</td><td>The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config.</td><td>string</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.ticket.renew.jitter</td><td>Percentage of random jitter added to the renewal time.</td><td>double</td><td>0.05</td><td></td><td>medium</td></tr> -<tr> -<td>sasl.kerberos.ticket.renew.window.factor</td><td>Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket.</td><td>double</td><td>0.8</td><td></td><td>medium</td></tr> -<tr> -<td>security.inter.broker.protocol</td><td>Security protocol used to communicate between brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.</td><td>string</td><td>PLAINTEXT</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.cipher.suites</td><td>A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol.By default all the available cipher suites are supported.</td><td>list</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.client.auth</td><td>Configures kafka broker to request client authentication. The following settings are common: <ul> <li><code>ssl.client.auth=required</code> If set to required client authentication is required. <li><code>ssl.client.auth=requested</code> This means client authentication is optional. unlike requested , if this option is set client can choose not to provide authentication information about itself <li><code>ssl.client.auth=none</code> This means client authentication is not needed.</td><td>string</td><td>none</td><td>[required, requested, none]</td><td>medium</td></tr> -<tr> -<td>ssl.enabled.protocols</td><td>The list of protocols enabled for SSL connections.</td><td>list</td><td>[TLSv1.2, TLSv1.1, TLSv1]</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.key.password</td><td>The password of the private key in the key store file. This is optional for client.</td><td>password</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.keymanager.algorithm</td><td>The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.</td><td>string</td><td>SunX509</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.keystore.location</td><td>The location of the key store file. This is optional for client and can be used for two-way authentication for client.</td><td>string</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.keystore.password</td><td>The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured. </td><td>password</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.keystore.type</td><td>The file format of the key store file. This is optional for client.</td><td>string</td><td>JKS</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.protocol</td><td>The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities.</td><td>string</td><td>TLS</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.provider</td><td>The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.</td><td>string</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.trustmanager.algorithm</td><td>The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.</td><td>string</td><td>PKIX</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.truststore.location</td><td>The location of the trust store file. </td><td>string</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.truststore.password</td><td>The password for the trust store file. </td><td>password</td><td>null</td><td></td><td>medium</td></tr> -<tr> -<td>ssl.truststore.type</td><td>The file format of the trust store file.</td><td>string</td><td>JKS</td><td></td><td>medium</td></tr> -<tr> -<td>authorizer.class.name</td><td>The authorizer class that should be used for authorization</td><td>string</td><td>""</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 number of samples maintained to compute metrics.</td><td>long</td><td>30000</td><td>[1,...]</td><td>low</td></tr> -<tr> -<td>quota.window.num</td><td>The number of samples to retain in memory</td><td>int</td><td>11</td><td>[1,...]</td><td>low</td></tr> -<tr> -<td>quota.window.size.seconds</td><td>The time span of each sample</td><td>int</td><td>1</td><td>[1,...]</td><td>low</td></tr> -<tr> -<td>ssl.endpoint.identification.algorithm</td><td>The endpoint identification algorithm to validate server hostname using server certificate. </td><td>string</td><td>null</td><td></td><td>low</td></tr> -<tr> -<td>zookeeper.sync.time.ms</td><td>How far a ZK follower can be behind a ZK leader</td><td>int</td><td>2000</td><td></td><td>low</td></tr> -</tbody></table>
