Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manual commit documentation page is misleading #1070

Open
memew1se opened this issue Nov 4, 2024 · 0 comments · May be fixed by #1071
Open

Manual commit documentation page is misleading #1070

memew1se opened this issue Nov 4, 2024 · 0 comments · May be fixed by #1071

Comments

@memew1se
Copy link

memew1se commented Nov 4, 2024

Describe the bug
Currently the documentation page of Manual commit states that:

When processing more sensitive data ``enable_auto_commit=False`` mode of
Consumer can lead to data loss in cases of critical failure. To avoid it we
can commit offsets manually after they were processed.

See: https://aiokafka.readthedocs.io/en/stable/examples/manual_commit.html#manual-commit

In this context the intended value of enable_auto_commit should be True, because with enable_auto_commit=False we already manually commit the message after we have processed it

Expected behaviour
The documentation page should differentiate states of setting enable_auto_commit

Environment (please complete the following information):

  • aiokafka version (python -c "import aiokafka; print(aiokafka.__version__)") 0.12.0:
  • Kafka Broker version (kafka-topics.sh --version) Not relevant:
  • Other information (Confluent Cloud version, etc.) Not relevant:

Reproducible example
Go to https://github.com/aio-libs/aiokafka/blob/master/docs/examples/manual_commit.rst?plain=1#L4-L6 and see the lines

@memew1se memew1se linked a pull request Nov 4, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant