docs: document the reconnect_delay_ms producer option - #122
Merged
Conversation
`reconnect_delay_ms` is already accepted and used by the producer (default 2000ms, plus 1..1000ms jitter, applied to reconnect attempts after the first), but it was missing from the `config_key`/`config_in`/`config_state` type specs and the producer option docs, so it was easy to miss and dialyzer did not recognise it as a valid key. Add it to the specs and document its behavior. No behavior change.
thalesmg
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make the existing
reconnect_delay_msproducer option a first-class, documented option. No behavior change.Background
reconnect_delay_msis already accepted and honored bywolff_producer:2000ms (viause_defaults).do_ensure_delayed_reconnect/2asreconnect_delay_ms + rand:uniform(1000)(1..1000 ms jitter, so partition workers do not all reconnect at the same instant).But it was missing from the
config_key()/config_in()/config_state()type specs and the producer option doc comment, so it was easy to miss and dialyzer did not recognise it as a valid producer config key.Change
reconnect_delay_mstoconfig_key(),config_in(), andconfig_state().Docs/types only — no runtime code path is touched.