Skip to content

Document force: shutdown parameter and graceful-by-default behavior #995

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.

Sign up for GitHub

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

Merged
mensfeld merged 2 commits into from
Aug 12, 2026
Merged

Document force: shutdown parameter and graceful-by-default behavior #995

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac96444
Document force: shutdown parameter and graceful-by-default behavior
coipond-writer[bot] Aug 11, 2026
6534c22
Remove unnecessary bold around "gracefully" per review feedback
coipond-writer[bot] Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions WaterDrop/Connection-Pool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ To use connection pools with WaterDrop:
WaterDrop::ConnectionPool.close
```

By default, `#close` (an alias for `#shutdown`) closes each pooled producer gracefully: buffered messages are flushed instead of being silently dropped, even if the broker is slow or unreachable. Pass `force: true` to force-close each producer instead, purging any messages that do not flush within the producer's max wait timeout:

```ruby
# Force-close, purging any messages that don't flush in time
WaterDrop::ConnectionPool.close(force: true)
```

!!! note "Auto-Closing in Karafka Applications"

When using the default connection pool within Karafka framework processes, the connection pool is automatically closed during framework shutdown, similar to how the default producer is handled. You do not need to close it manually in Karafka processes.
Expand Down