Rdkafka Changelog¶
0.25.0 (Unreleased)¶
- [Breaking] Change
AbstractHandle#waitparameter frommax_wait_timeout:(seconds) tomax_wait_timeout_ms:(milliseconds). - [Breaking] Change
PartitionsCountCacheconstructor parameter fromttl(seconds) tottl_ms(milliseconds). - [Enhancement] Extract all timeout defaults to
Rdkafka::Defaultsmodule for discoverability and per-call overrides (#310). All time-related values are now in milliseconds for consistency. - [Enhancement] Add
timeout_msparameter toConsumer#eachfor configurable poll timeout. - [Enhancement] Extract non-time configuration values (
METADATA_MAX_RETRIES,PARTITIONS_COUNT_CACHE_TTL_MS) toRdkafka::Defaultsmodule. - [Enhancement] Bump librdkafka to
2.12.1 - [Enhancement] Add descriptive error messages for glibc compatibility issues with instructions for resolution (#654)
- [Enhancement] Replace magic numbers with named constants throughout codebase for improved readability and maintainability
0.24.2 (2025-10-31)¶
- [Enhancement] Force lock FFI to 1.17.1 or higher to include critical bug fixes around GCC, write barriers, and thread restarts for forks.
- [Fix] Fix for Core dump when providing extensions to oauthbearer_set_token (dssjoblom)
0.24.1 (2025-10-10)¶
- [Fix] Fix Github Action Ruby reference preventing non-compiled releases.
0.24.0 (2025-10-10)¶
- [Enhancement] Bump librdkafka to
2.11.1
0.23.1 (2025-09-25)¶
- [Enhancement] Improve sigstore attestation for precompiled releases.
- [Fix] Fix incorrectly set default SSL certs dir.
- [Fix] Disable OpenSSL Heartbeats during compilation.
0.23.0 (2025-09-04)¶
- [EOL] Drop support for Ruby 3.1 to move forward with the fiber scheduler work.
- [Enhancement] Bump librdkafka to
2.11.0 - [Enhancement] Support explicit Debian testing due to lib issues.
- [Enhancement] Support ARM64 Gnu precompilation.
- [Enhancement] Improve what symbols are exposed outside of the precompiled extensions.
- [Enhancement] Introduce an integration suite layer for non RSpec specs execution.
- [Fix] Add
jsongem as a dependency (was missing but used).
0.22.2 (2025-07-21)¶
- [Enhancement] Drastically increase number of platforms in the integration suite
- [Fix] Support Ubuntu
22.04and older Alpine precompiled versions - [Fix] FFI::DynamicLibrary.load_library': Could not open library
- [Change] Add new CI action to trigger auto-doc refresh.
0.22.1 (2025-07-17)¶
- [Fix] Fix
Rakefilebeing available in the precompiled versions causing build failures.
0.22.0 (2025-07-17)¶
- [Feature] Add precompiled
x86_64-linux-gnusetup. - [Feature] Add precompiled
x86_64-linux-muslsetup. - [Feature] Add precompiled
macos_arm64setup. - [Fix] Fix a case where using empty key on the
muslarchitecture would cause a segfault. - [Fix] Fix for null pointer reference bypass on empty string being too wide causing segfault.
- [Enhancement] Allow for producing to non-existing topics with
keyandpartition_keypresent. - [Enhancement] Replace TTL-based partition count cache with a global cache that reuses
librdkafkastatistics data when possible. - [Enhancement] Support producing and consuming of headers with mulitple values (KIP-82).
- [Enhancement] Allow native Kafka customization poll time.
- [Enhancement] Roll out experimental jruby support.
- [Enhancement] Run all specs on each of the platforms with and without precompilation.
- [Enhancement] Support transactional id in the ACL API.
- [Fix] Fix issue where post-closed producer C topics refs would not be cleaned.
- [Fix] Fiber causes Segmentation Fault.
- [Change] Move to trusted-publishers and remove signing since no longer needed.
Note: Precompiled extensions are a new feature in this release. While they significantly improve installation speed and reduce build dependencies, they should be thoroughly tested in your staging environment before deploying to production. If you encounter any issues with precompiled extensions, you can fall back to building from sources. For more information, see the Native Extensions documentation.
0.21.0 (2025-02-13)¶
- [Enhancement] Bump librdkafka to
2.8.0
0.20.0 (2025-01-07)¶
- [Breaking] Deprecate and remove
#each_batchdue to data consistency concerns. - [Enhancement] Bump librdkafka to
2.6.1 - [Enhancement] Expose
rd_kafka_global_initto mitigate macos forking issues. - [Enhancement] Avoid clobbering LDFLAGS and CPPFLAGS if in a nix prepared environment (secobarbital).
- [Patch] Retire no longer needed cooperative-sticky patch.
0.19.0 (2024-10-01)¶
- [EOL] Drop Ruby 3.0 support
- [Enhancement] Update
librdkafkato2.5.3 - [Enhancement] Use default oauth callback if none is passed (bachmanity1)
- [Fix] Fix incorrectly behaving CI on failures.
- [Patch] Patch with "Add forward declaration to fix compilation without ssl" fix
0.18.0 (2024-09-02)¶
- [Enhancement] Update
librdkafkato2.5.0 - [Enhancement] Do not release GVL on
rd_kafka_name(ferrous26) - [Patch] Patch cooperative-sticky assignments in librdkafka.
- [Fix] Mitigate a case where FFI would not restart the background events callback dispatcher in forks
- [Fix] Fix unused variable reference in producer (lucasmvnascimento)
0.17.0 (2024-08-03)¶
- [Feature] Add
#seek_byto be able to seek for a message by topic, partition and offset (zinahia) - [Enhancement] Update
librdkafkato2.4.0 - [Enhancement] Support ability to release patches to librdkafka.
- [Change] Remove old producer timeout API warnings.
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.16.1 (2024-07-10)¶
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.16.0 (2024-06-13)¶
- [EOL] Retire support for Ruby 2.7.
- [Breaking] Messages without headers returned by
#pollcontain frozen empty hash. - [Breaking]
HashWithSymbolKeysTreatedLikeStringshas been removed so headers are regular hashes with string keys. - [Feature] Support incremental config describe + alter API.
- [Feature] Oauthbearer token refresh callback (bruce-szalwinski-he)
- [Feature] Provide ability to use topic config on a producer for custom behaviors per dispatch.
- [Enhancement] Use topic config reference cache for messages production to prevent topic objects allocation with each message.
- [Enhancement] Provide
Rrdkafka::Admin#describe_errorsto get errors descriptions (mensfeld) - [Enhancement] Replace time poll based wait engine with an event based to improve response times on blocking operations and wait (nijikon + mensfeld)
- [Enhancement] Allow for usage of the second regex engine of librdkafka by setting
RDKAFKA_DISABLE_REGEX_EXTduring build (mensfeld) - [Enhancement] name polling Thread as
rdkafka.native_kafka#<name>(nijikon) - [Enhancement] Save two objects on message produced and lower CPU usage on message produced with small improvements.
- [Change] Allow for native kafka thread operations deferring and manual start for consumer, producer and admin.
- [Change] The
wait_timeoutargument inAbstractHandle.waitmethod is deprecated and will be removed in future versions without replacement. We don't rely on it's value anymore (nijikon) - [Fix] Background logger stops working after forking causing memory leaks (mensfeld)
- [Fix] Fix bogus case/when syntax. Levels 1, 2, and 6 previously defaulted to UNKNOWN (jjowdy)
0.15.2 (2024-07-10)¶
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.15.1 (2024-01-30)¶
- [Enhancement] Provide support for Nix OS (alexandriainfantino)
- [Enhancement] Replace
rd_kafka_offset_storewithrd_kafka_offsets_store(mensfeld) - [Enhancement] Alias
topic_nameastopicin the delivery report (mensfeld) - [Enhancement] Provide
labelproducer handler and report reference for improved traceability (mensfeld) - [Enhancement] Include the error when invoking
create_resulton producer handle (mensfeld) - [Enhancement] Skip intermediate array creation on delivery report callback execution (one per message) (mensfeld).
- [Enhancement] Report
-1instead ofnilin casepartition_countfailure (mensfeld). - [Fix] Fix return type on
#rd_kafka_poll(mensfeld) - [Fix]
uint8_tdoes not exist on Apple Silicon (mensfeld) - [Fix] Missing ACL
RD_KAFKA_RESOURCE_BROKERconstant reference (mensfeld) - [Fix] Partition cache caches invalid nil result for
PARTITIONS_COUNT_TTL(mensfeld) - [Change] Rename
matching_acl_pattern_typetomatching_acl_resource_pattern_typeto align the whole API (mensfeld)
0.15.0 (2023-12-03)¶
- [Feature] Add
Admin#metadata(mensfeld) - [Feature] Add
Admin#create_partitions(mensfeld) - [Feature] Add
Admin#delete_grouputility (piotaixr) - [Feature] Add Create and Delete ACL Feature To Admin Functions (vgnanasekaran)
- [Feature] Support
#assignment_lost?on a consumer to check for involuntary assignment revocation (mensfeld) - [Enhancement] Expose alternative way of managing consumer events via a separate queue (mensfeld)
- [Enhancement] Bump librdkafka to 2.3.0 (mensfeld)
- [Enhancement] Increase the
#lagand#query_watermark_offsetsdefault timeouts from 100ms to 1000ms. This will compensate for network glitches and remote clusters operations (mensfeld) - [Change] Use
SecureRandom.uuidinstead ofrandomfor test consumer groups (mensfeld)
0.14.1 (2024-07-10)¶
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.14.0 (2023-11-21)¶
- [Enhancement] Add
raise_response_errorflag to theRdkafka::AbstractHandle. - [Enhancement] Allow for setting
statistics_callbackas nil to reset predefined settings configured by a different gem (mensfeld) - [Enhancement] Get consumer position (thijsc & mensfeld)
- [Enhancement] Provide
#purgeto remove any outstanding requests from the producer (mensfeld) - [Enhancement] Update
librdkafkato2.2.0(mensfeld) - [Enhancement] Introduce producer partitions count metadata cache (mensfeld)
- [Enhancement] Increase metadata timeout request from
250 msto2000 msdefault to allow for remote cluster operations viardkafka-ruby(mensfeld) - [Enhancement] Introduce
#namefor producers and consumers (mensfeld) - [Enhancement] Include backtrace in non-raised binded errors (mensfeld)
- [Fix] Reference to Opaque is not released when Admin, Consumer or Producer is closed (mensfeld)
- [Fix] Trigger
#pollon native kafka creation to handle oauthbearer cb (mensfeld) - [Fix]
#flushdoes not handle the timeouts errors by making it returntrueif all flushed orfalseif failed. We do not raise an exception here to keep it backwards compatible (mensfeld) - [EOL] Remove support for Ruby 2.6 due to it being EOL and WeakMap incompatibilities (mensfeld)
- [Change] Update Kafka Docker with Confluent KRaft (mensfeld)
- [Change] Update librdkafka repo reference from edenhill to confluentinc (mensfeld)
0.13.1 (2024-07-10)¶
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.13.0 (2023-07-24)¶
- Support cooperative sticky partition assignment in the rebalance callback (methodmissing)
- Support both string and symbol header keys (ColinDKelley)
- Handle tombstone messages properly (kgalieva)
- Add topic name to delivery report (maeve)
- Allow string partitioner config (mollyegibson)
- Fix documented type for DeliveryReport#error (jimmydo)
- Bump librdkafka to 2.0.2 (lmaia)
- Use finalizers to cleanly exit producer and admin (thijsc)
- Lock access to the native kafka client (thijsc)
- Fix potential race condition in multi-threaded producer (mensfeld)
- Fix leaking FFI resources in specs (mensfeld)
- Improve specs stability (mensfeld)
- Make metadata request timeout configurable (mensfeld)
- call_on_partitions_assigned and call_on_partitions_revoked only get a tpl passed in (thijsc)
0.12.1 (2024-07-11)¶
- [Fix] Switch to local release of librdkafka to mitigate its unavailability.
0.12.0 (2022-06-17)¶
- Bumps librdkafka to 1.9.0
- Fix crash on empty partition key (mensfeld)
- Pass the delivery handle to the callback (gvisokinskas)
0.11.0 (2021-11-17)¶
- Upgrade librdkafka to 1.8.2
- Bump supported minimum Ruby version to 2.6
- Better homebrew path detection
0.10.0 (2021-09-07)¶
- Upgrade librdkafka to 1.5.0
- Add error callback config
0.9.0 (2021-06-23)¶
- Fixes for Ruby 3.0
- Allow any callable object for callbacks (gremerritt)
- Reduce memory allocations in Rdkafka::Producer#produce (jturkel)
- Use queue as log callback to avoid unsafe calls from trap context (breunigs)
- Allow passing in topic configuration on create_topic (dezka)
- Add each_batch method to consumer (mgrosso)
0.8.1 (2020-12-07)¶
- Fix topic_flag behaviour and add tests for Metadata (geoff2k)
- Add topic admin interface (geoff2k)
- Raise an exception if @native_kafka is nil (geoff2k)
- Option to use zstd compression (jasonmartens)
0.8.0 (2020-06-02)¶
- Upgrade librdkafka to 1.4.0
- Integrate librdkafka metadata API and add partition_key (by Adithya-copart)
- Ruby 2.7 compatibility fix (by Geoff TheĢ)A
- Add error to delivery report (by Alex Stanovsky)
- Don't override CPPFLAGS and LDFLAGS if already set on Mac (by Hiroshi Hatake)
- Allow use of Rake 13.x and up (by Tomasz Pajor)
0.7.0 (2019-09-21)¶
- Bump librdkafka to 1.2.0 (by rob-as)
- Allow customizing the wait time for delivery report availability (by mensfeld)
0.6.0 (2019-07-23)¶
- Bump librdkafka to 1.1.0 (by Chris Gaffney)
- Implement seek (by breunigs)
0.5.0 (2019-04-11)¶
- Bump librdkafka to 1.0.0 (by breunigs)
- Add cluster and member information (by dmexe)
- Support message headers for consumer & producer (by dmexe)
- Add consumer rebalance listener (by dmexe)
- Implement pause/resume partitions (by dmexe)
0.4.2 (2019-01-12)¶
- Delivery callback for producer
- Document list param of commit method
- Use default Homebrew openssl location if present
- Consumer lag handles empty topics
- End iteration in consumer when it is closed
- Add support for storing message offsets
- Add missing runtime dependency to rake
0.4.1 (2018-10-19)¶
- Bump librdkafka to 0.11.6
0.4.0 (2018-09-24)¶
- Improvements in librdkafka archive download
- Add global statistics callback
- Use Time for timestamps, potentially breaking change if you rely on the previous behavior where it returns an integer with the number of milliseconds.
- Bump librdkafka to 0.11.5
- Implement TopicPartitionList in Ruby so we don't have to keep track of native objects.
- Support committing a topic partition list
- Add consumer assignment method
0.3.5 (2018-01-17)¶
- Fix crash when not waiting for delivery handles
- Run specs on Ruby 2.5
0.3.4 (2017-12-05)¶
- Bump librdkafka to 0.11.3
0.3.3 (2017-10-27)¶
- Fix bug that prevent display of
RdkafkaErrormessage
0.3.2 (2017-10-25)¶
add_topicnow supports using a partition count- Add way to make errors clearer with an extra message
- Show topics in subscribe error message
- Show partition and topic in query watermark offsets error message
0.3.1 (2017-10-23)¶
- Bump librdkafka to 0.11.1
- Officially support ranges in
add_topicfor topic partition list. - Add consumer lag calculator
0.3.0 (2017-10-17)¶
- Move both add topic methods to one
add_topicinTopicPartitionList - Add committed offsets to consumer
- Add query watermark offset to consumer
0.2.0 (2017-10-13)¶
- Some refactoring and add inline documentation
0.1.x (2017-09-10)¶
- Initial working version including producing and consuming
Last modified: 2025-12-09 13:01:11