[
https://issues.apache.org/jira/browse/KAFKA-6312?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16586472#comment-16586472
]
ASF GitHub Bot commented on KAFKA-6312:
---------------------------------------
hachikuji closed pull request #4527: KAFKA-6312 Add documentation about
kafka-consumer-groups.sh's ability…
URL: https://github.com/apache/kafka/pull/4527
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/ops.html b/docs/ops.html
index 95b9a960172..6fe8fffeba2 100644
--- a/docs/ops.html
+++ b/docs/ops.html
@@ -229,6 +229,69 @@ <h4><a id="basic_ops_consumer_group"
href="#basic_ops_consumer_group">Managing C
Deletion of requested consumer groups ('my-group', 'my-other-group') was
successful.
</pre>
+ <p>
+ To reset offsets of a consumer group, "--reset-offsets" option can be used.
+ This option supports one consumer group at the time. It requires defining
following scopes: --all-topics or --topic. One scope must be selected, unless
you use '--from-file' scenario. Also, first make sure that the consumer
instances are inactive.
+ See <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-122%3A+Add+Reset+Consumer+Group+Offsets+tooling";>KIP-122</a>
for more details.
+
+ <p>
+ It has 3 execution options:
+ <ul>
+ <li>
+ (default) to display which offsets to reset.
+ </li>
+ <li>
+ --execute : to execute --reset-offsets process.
+ </li>
+ <li>
+ --export : to export the results to a CSV format.
+ </li>
+ </ul>
+
+ <p>
+ --reset-offsets also has following scenarios to choose from (atleast one
scenario must be selected):
+ <ul>
+ <li>
+ --to-datetime <String: datetime> : Reset offsets to offsets from
datetime. Format: 'YYYY-MM-DDTHH:mm:SS.sss'
+ </li>
+ <li>
+ --to-earliest : Reset offsets to earliest offset.
+ </li>
+ <li>
+ --to-latest : Reset offsets to latest offset.
+ </li>
+ <li>
+ --shift-by <Long: number-of-offsets> : Reset offsets shifting
current offset by 'n', where 'n' can be positive or negative.
+ </li>
+ <li>
+ --from-file : Reset offsets to values defined in CSV file.
+ </li>
+ <li>
+ --to-current : Resets offsets to current offset.
+ </li>
+ <li>
+ --by-duration <String: duration> : Reset offsets to offset by
duration from current timestamp. Format: 'PnDTnHnMnS'
+ </li>
+ <li>
+ --to-offset : Reset offsets to a specific offset.
+ </li>
+ </ul>
+
+ Please note, that out of range offsets will be adjusted to available offset
end. For example, if offset end is at 10 and offset shift request is
+ of 15, then, offset at 10 will actually be selected.
+
+ <p>
+ For example, to reset offsets of a consumer group to the latest offset:
+
+ <pre class="brush: bash;">
+ > bin/kafka-consumer-groups.sh --bootstrap-server localhost:9092
--reset-offsets --group consumergroup1 --topic topic1 --to-latest
+
+ TOPIC PARTITION NEW-OFFSET
+ topic1 0 0
+ </pre>
+
+ <p>
+
If you are using the old high-level consumer and storing the group metadata
in ZooKeeper (i.e. <code>offsets.storage=zookeeper</code>), pass
<code>--zookeeper</code> instead of <code>bootstrap-server</code>:
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Add documentation about kafka-consumer-groups.sh's ability to set/change
> offsets
> --------------------------------------------------------------------------------
>
> Key: KAFKA-6312
> URL: https://issues.apache.org/jira/browse/KAFKA-6312
> Project: Kafka
> Issue Type: Improvement
> Components: documentation
> Reporter: James Cheng
> Assignee: Mayank Tankhiwale
> Priority: Major
> Labels: newbie
>
> KIP-122 added the ability for kafka-consumer-groups.sh to reset/change
> consumer offsets, at a fine grained level.
> There is documentation on it in the kafka-consumer-groups.sh usage text.
> There is no such documentation on the kafka.apache.org website. We should add
> some documentation to the website, so that users can read about the
> functionality without having the tools installed.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
