kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mj...@apache.org
Subject [kafka] branch 1.1 updated: MINOR: Add missing configs for resilience settings
Date Tue, 05 Jun 2018 18:45:19 GMT
This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch 1.1
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/1.1 by this push:
     new c1fa2b0  MINOR: Add missing configs for resilience settings
c1fa2b0 is described below

commit c1fa2b05804d5cf85b18ef5a46db18a94f9ec677
Author: Guozhang Wang <wangguoz@gmail.com>
AuthorDate: Tue Jun 5 11:41:03 2018 -0700

    MINOR: Add missing configs for resilience settings
    
    Reviewers: Matthias J. Sax <matthias@confluent.io>, Bill Bejeck <bill@confluent.io>
---
 docs/streams/developer-guide/config-streams.html | 36 +++++++++++++++++++-----
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/docs/streams/developer-guide/config-streams.html b/docs/streams/developer-guide/config-streams.html
index 75f155b..98375b1 100644
--- a/docs/streams/developer-guide/config-streams.html
+++ b/docs/streams/developer-guide/config-streams.html
@@ -278,6 +278,16 @@
             <td colspan="2">The replication factor for changelog topics and repartition
topics created by the application.</td>
             <td>1</td>
           </tr>
+          <tr class="row-even"><td>retries</td>
+              <td>Medium</td>
+              <td colspan="2">The number of retries for broker requests that return
a retryable error. </td>
+              <td>0</td>
+          </tr>
+          <tr class="row-even"><td>retry.backoff.ms</td>
+              <td>Medium</td>
+              <td colspan="2">The amount of time in milliseconds, before a request
is retried. This applies if the <code class="docutils literal"><span class="pre">retries</span></code>
parameter is configured to be greater than 0. </td>
+              <td>100</td>
+          </tr>
           <tr class="row-odd"><td>state.cleanup.delay.ms</td>
             <td>Low</td>
             <td colspan="2">The amount of time in milliseconds to wait before deleting
state when a partition has migrated.</td>
@@ -533,9 +543,10 @@
         </div>
       </div>
       <div class="section" id="kafka-consumers-and-producer-configuration-parameters">
-        <h3><a class="toc-backref" href="#id16">Kafka consumers and producer
configuration parameters</a><a class="headerlink" href="#kafka-consumers-and-producer-configuration-parameters"
title="Permalink to this headline"></a></h3>
-        <p>You can specify parameters for the Kafka <a class="reference external"
href="../../../javadoc/org/apache/kafka/clients/consumer/package-summary.html">consumers</a>
and <a class="reference external" href="../../../javadoc/org/apache/kafka/clients/producer/package-summary.html">producers</a>
that are used internally.  The consumer and producer settings
-          are defined by specifying parameters in a <code class="docutils literal"><span
class="pre">StreamsConfig</span></code> instance.</p>
+        <h3><a class="toc-backref" href="#id16">Kafka consumers, producer and
admin client configuration parameters</a><a class="headerlink" href="#kafka-consumers-and-producer-configuration-parameters"
title="Permalink to this headline"></a></h3>
+        <p>You can specify parameters for the Kafka <a class="reference external"
href="../../../javadoc/org/apache/kafka/clients/consumer/package-summary.html">consumers</a>,
<a class="reference external" href="../../../javadoc/org/apache/kafka/clients/producer/package-summary.html">producers</a>,
+            and <a class="reference external" href="../../../javadoc/org/apache/kafka/kafka/clients/admin/package-summary.html">admin
client</a> that are used internally.
+            The consumer, producer and admin client settings are defined by specifying parameters
in a <code class="docutils literal"><span class="pre">StreamsConfig</span></code>
instance.</p>
         <p>In this example, the Kafka <a class="reference external" href="../../../javadoc/org/apache/kafka/clients/consumer/ConsumerConfig.html#SESSION_TIMEOUT_MS_CONFIG">consumer
session timeout</a> is configured to be 60000 milliseconds in the Streams settings:</p>
         <div class="highlight-java"><div class="highlight"><pre><span></span><span
class="n">Properties</span> <span class="n">streamsSettings</span> <span
class="o">=</span> <span class="k">new</span> <span class="n">Properties</span><span
class="o">();</span>
 <span class="c1">// Example of a &quot;normal&quot; setting for Kafka Streams</span>
@@ -547,18 +558,21 @@
         </div>
         <div class="section" id="naming">
           <h4><a class="toc-backref" href="#id17">Naming</a><a class="headerlink"
href="#naming" title="Permalink to this headline"></a></h4>
-          <p>Some consumer and producer configuration parameters use the same parameter
name. For example, <code class="docutils literal"><span class="pre">send.buffer.bytes</span></code>
and
-            <code class="docutils literal"><span class="pre">receive.buffer.bytes</span></code>
are used to configure TCP buffers; <code class="docutils literal"><span class="pre">request.timeout.ms</span></code>
and <code class="docutils literal"><span class="pre">retry.backoff.ms</span></code>
control retries
-            for client request. You can avoid duplicate names by prefix parameter names with
<code class="docutils literal"><span class="pre">consumer.</span></code>
or <code class="docutils literal"><span class="pre">producer</span></code>
(e.g., <code class="docutils literal"><span class="pre">consumer.send.buffer.bytes</span></code>
and <code class="docutils literal"><span class="pre">producer.send.buffer.bytes</span></code>).</p>
+          <p>Some consumer, producer and admin client configuration parameters use
the same parameter name, and Kafka Streams library itself also uses some parameters that share
the same name with its embedded client. For example, <code class="docutils literal"><span
class="pre">send.buffer.bytes</span></code> and
+              <code class="docutils literal"><span class="pre">receive.buffer.bytes</span></code>
are used to configure TCP buffers; <code class="docutils literal"><span class="pre">request.timeout.ms</span></code>
and <code class="docutils literal"><span class="pre">retry.backoff.ms</span></code>
control retries for client request;
+              <code class="docutils literal"><span class="pre">retries</span></code>
are used to configure how many retries are allowed when handling retriable errors from broker
request responses.
+              You can avoid duplicate names by prefix parameter names with <code class="docutils
literal"><span class="pre">consumer.</span></code>, <code class="docutils
literal"><span class="pre">producer.</span></code>, or <code class="docutils
literal"><span class="pre">admin.</span></code> (e.g., <code class="docutils
literal"><span class="pre">consumer.send.buffer.bytes</span></code> and
<code class="docutils literal"><span class="pre">producer.send.buffer.bytes</span></code>).</p>
           <div class="highlight-java"><div class="highlight"><pre><span></span><span
class="n">Properties</span> <span class="n">streamsSettings</span> <span
class="o">=</span> <span class="k">new</span> <span class="n">Properties</span><span
class="o">();</span>
-<span class="c1">// same value for consumer and producer</span>
+<span class="c1">// same value for consumer, producer, and admin client</span>
 <span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="s">&quot;PARAMETER_NAME&quot;</span><span
class="o">,</span> <span class="s">&quot;value&quot;</span><span
class="o">);</span>
 <span class="c1">// different values for consumer and producer</span>
 <span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="s">&quot;consumer.PARAMETER_NAME&quot;</span><span
class="o">,</span> <span class="s">&quot;consumer-value&quot;</span><span
class="o">);</span>
 <span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="s">&quot;producer.PARAMETER_NAME&quot;</span><span
class="o">,</span> <span class="s">&quot;producer-value&quot;</span><span
class="o">);</span>
+<span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="s">&quot;admin.PARAMETER_NAME&quot;</span><span
class="o">,</span> <span class="s">&quot;admin-value&quot;</span><span
class="o">);</span>
 <span class="c1">// alternatively, you can use</span>
 <span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="n">StreamsConfig</span><span
class="o">.</span><span class="na">consumerPrefix</span><span class="o">(</span><span
class="s">&quot;PARAMETER_NAME&quot;</span><span class="o">),</span>
<span class="s">&quot;consumer-value&quot;</span><span class="o">);</span>
 <span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="n">StreamsConfig</span><span
class="o">.</span><span class="na">producerPrefix</span><span class="o">(</span><span
class="s">&quot;PARAMETER_NAME&quot;</span><span class="o">),</span>
<span class="s">&quot;producer-value&quot;</span><span class="o">);</span>
+<span class="n">streamsSettings</span><span class="o">.</span><span
class="na">put</span><span class="o">(</span><span class="n">StreamsConfig</span><span
class="o">.</span><span class="na">adminClientPrefix</span><span class="o">(</span><span
class="s">&quot;PARAMETER_NAME&quot;</span><span class="o">),</span>
<span class="s">&quot;admin-value&quot;</span><span class="o">);</span>
 </pre></div>
           </div>
         </div>
@@ -581,6 +595,14 @@
             </thead>
             <tbody valign="top">
             <tr class="row-even"><td>auto.offset.reset</td>
+                <td>Global Consumer</td>
+                <td>none (cannot be changed)</td>
+            </tr>
+            <tr class="row-even"><td>auto.offset.reset</td>
+                <td>Restore Consumer</td>
+                <td>none (cannot be changed)</td>
+            </tr>
+            <tr class="row-even"><td>auto.offset.reset</td>
               <td>Consumer</td>
               <td>earliest</td>
             </tr>

-- 
To stop receiving notification emails like this one, please contact
mjsax@apache.org.

Mime
View raw message