kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject [kafka] branch trunk updated: Updating docs for streams app reset tool (#4401)
Date Mon, 08 Jan 2018 20:02:32 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/trunk by this push:
     new 2900af6  Updating docs for streams app reset tool (#4401)
2900af6 is described below

commit 2900af6b33c8d6a12459dcdd0e1fb4b49676c2ff
Author: Jorge Quilcate Otoya <quilcate.jorge@gmail.com>
AuthorDate: Mon Jan 8 21:02:29 2018 +0100

    Updating docs for streams app reset tool (#4401)
    
    Reviewers: Matthias J. Sax <matthias@confluent.io>, Guozhang Wang <wangguoz@gmail.com>
---
 docs/streams/developer-guide/app-reset-tool.html | 27 ++++++++++++++++++++++--
 docs/streams/upgrade-guide.html                  |  5 +++++
 2 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/docs/streams/developer-guide/app-reset-tool.html b/docs/streams/developer-guide/app-reset-tool.html
index dfee64f..769dc39 100644
--- a/docs/streams/developer-guide/app-reset-tool.html
+++ b/docs/streams/developer-guide/app-reset-tool.html
@@ -40,7 +40,7 @@
             when resetting the application.</p>
         <p>Here&#8217;s what the application reset tool does for each topic type:</p>
         <ul class="simple">
-            <li>Input topics: Reset to the beginning of the topic. This means that
it sets the application&#8217;s committed consumer offsets for all partitions to each
partition&#8217;s <code class="docutils literal"><span class="pre">earliest</span></code>
offset (for consumer group <code class="docutils literal"><span class="pre">application.id</span></code>).</li>
+            <li>Input topics: Reset offsets to specified position (by default to the
beginning of the topic).</li>
             <li>Intermediate topics: Skip to the end of the topic, i.e., set the application&#8217;s
committed consumer offsets for all partitions to each partition&#8217;s <code class="docutils
literal"><span class="pre">logSize</span></code> (for consumer group
<code class="docutils literal"><span class="pre">application.id</span></code>).</li>
             <li>Internal topics: Delete the internal topic (this automatically deletes
any committed offsets).</li>
         </ul>
@@ -87,12 +87,16 @@
 --bootstrap-servers &lt;String: urls&gt;    Comma-separated list of broker urls with
                                         format: HOST1:PORT1,HOST2:PORT2
                                         <span class="o">(</span>default: localhost:9092<span
class="o">)</span>
+--by-duration &lt;String: urls&gt;      Reset offsets to offset by duration from
+                                        current timestamp. Format: '<span>PnDTnHnMnS</span>'
 --config-file &lt;String: file name&gt;     Property file containing configs to be
                                         passed to admin clients and embedded
                                         consumer.
 --dry-run                             Display the actions that would be
                                         performed without executing the reset
                                         commands.
+--from-file &lt;String: urls&gt;        Reset offsets to values defined in CSV
+                                        file.
 --input-topics &lt;String: list&gt;         Comma-separated list of user input
                                         topics. For these topics, the tool will
                                         reset the offset to the earliest
@@ -101,13 +105,32 @@
                                         topics <span class="o">(</span>topics
used in the through<span class="o">()</span>
                                         method<span class="o">)</span>. For these
topics, the tool
                                         will skip to the end.
+--shift-by &lt;Long: number-of-offsets&gt; Reset offsets shifting current offset
by
+                                        'n', where 'n' can be positive or
+                                        negative
+--to-datetime &lt;String&gt;                Reset offsets to offset from datetime.
+                                        Format: 'YYYY-MM-DDTHH:mm:SS.sss'
+--to-earliest                         Reset offsets to earliest offset.
+--to-latest                           Reset offsets to latest offset.
+--to-offset &lt;Long&gt;                    Reset offsets to a specific offset.
 --zookeeper                           Zookeeper option is deprecated by
                                         bootstrap.servers, as the reset tool
                                         would no longer access Zookeeper
                                         directly.
 </pre></div>
             </div>
-            <p>Parameters can be combined as needed.  For example, if you want to restart
an application from an
+            <p>Consider the following as reset-offset scenarios for <code>input-topics</code>:</p>
+            <ul>
+                <li> by-duration</li>
+                <li> from-file</li>
+                <li> shift-by</li>
+                <li> to-datetime</li>
+                <li> to-earliest</li>
+                <li> to-latest</li>
+                <li> to-offset</li>
+            </ul>
+            <p>Only one of these scenarios can be defined. If not, <code>to-earliest</code>
will be executed by default</p>
+            <p>All the other parameters can be combined as needed.  For example, if
you want to restart an application from an
                 empty internal state, but not reprocess previous data, simply omit the parameters
<code class="docutils literal"><span class="pre">--input-topics</span></code>
and
                 <code class="docutils literal"><span class="pre">--intermediate-topics</span></code>.</p>
         </div>
diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html
index c98acdb..7567abd 100644
--- a/docs/streams/upgrade-guide.html
+++ b/docs/streams/upgrade-guide.html
@@ -90,6 +90,11 @@
         <li>changing which implementation is used can be done by settings <code>default.production.exception.handler</code>
to the fully qualified name of a class implementing this interface.</li>
     </ul>
 
+    <p> Changes in <code>StreamsResetter</code>: </p>
+    <ul>
+        <li> added options to specify input topics offsets to reset according to <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-171+-+Extend+Consumer+Group+Reset+Offset+for+Stream+Application">KIP-171</a></li>
+    </ul>
+
     <h3><a id="streams_api_changes_100" href="#streams_api_changes_100">Streams
API changes in 1.0.0</a></h3>
 
     <p>

-- 
To stop receiving notification emails like this one, please contact
['"commits@kafka.apache.org" <commits@kafka.apache.org>'].

Mime
View raw message