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

Document connections_max_idle_ms #1497

Closed
jeffwidman opened this issue May 14, 2018 · 0 comments
Closed

Document connections_max_idle_ms #1497

jeffwidman opened this issue May 14, 2018 · 0 comments

Comments

@jeffwidman
Copy link
Collaborator

Need to document connections_max_idle_ms which was added in #1068.

Should be documented in KafkaProducer, KafkaConsumer, and KafkaClient.

As part of documenting, perhaps for the consumer should also add a mention in both request timeout and session timeout that you must always set connection timeout > request timeout > session timeout.

For context:
One of the teams I support was changing their session timeout to greater than 10 minutes for a particular use case. I realized they needed to change the request timeout, but didn't realize they needed to change the connection timeout. As a result, the broker sat idly waiting for the consumer to come back, even after they'd lowered the session timeout and restarted the consumers, because it was waiting for the old consumer (which was never coming back) using the old session timeout.

@jeffwidman jeffwidman changed the title 'connections_max_idle_ms' is undocumented Document connections_max_idle_ms May 14, 2018
jeffwidman added a commit that referenced this issue Jun 26, 2018
This was added in #1068 but never documented.
Fix #1497
jeffwidman added a commit that referenced this issue Jun 26, 2018
This was added in #1068 but never documented.
Fix #1497
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

No branches or pull requests

1 participant