Skip to content

Commit 0bc9462

Browse files
authored
Add documentation for no-strict-offset-reset (#459)
1 parent 8f5ced4 commit 0bc9462

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ Contents:
1414
dlqs
1515
backpressure
1616
metrics
17+
parameters

docs/source/parameters.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
==========================
2+
Common consumer parameters
3+
==========================
4+
5+
Many consumers expose a CLI interface on top of arroyo, but in the case of
6+
Sentry's own consumers they all look very similar. This page is there to
7+
explain some of them.
8+
9+
* ``--no-strict-offset-reset``: Arroyo, by default, overwrites rdkafka's offset
10+
reset behavior to always error when the underlying offset is out of range.
11+
That means ``auto-offset-reset: latest`` will reset to latest when the offset
12+
does not yet exist, but still error if the offset is out of range. This is to
13+
prevent accidental data loss during incident response, when a consumer has
14+
been backlogged for a very long time.
15+
16+
In arroyo the parameter can be passed as kafka configuration parameter
17+
``arroyo.strict.offset.reset``.

0 commit comments

Comments
 (0)