karafka-rdkafka 0.28.0 → 0.28.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +46 -30
- data/README.md +3 -3
- data/lib/rdkafka/admin/create_acl_report.rb +2 -1
- data/lib/rdkafka/admin/delete_records_handle.rb +31 -0
- data/lib/rdkafka/admin/delete_records_report.rb +25 -0
- data/lib/rdkafka/admin/describe_acl_report.rb +2 -1
- data/lib/rdkafka/admin/list_consumer_groups_handle.rb +31 -0
- data/lib/rdkafka/admin/list_consumer_groups_report.rb +83 -0
- data/lib/rdkafka/admin.rb +317 -90
- data/lib/rdkafka/bindings.rb +52 -13
- data/lib/rdkafka/callbacks/delete_records_handler.rb +38 -0
- data/lib/rdkafka/callbacks/list_consumer_groups_handler.rb +39 -0
- data/lib/rdkafka/callbacks.rb +4 -2
- data/lib/rdkafka/clients.rb +114 -0
- data/lib/rdkafka/config.rb +103 -56
- data/lib/rdkafka/consumer/allocator.rb +38 -0
- data/lib/rdkafka/consumer/topic_partition_list.rb +16 -12
- data/lib/rdkafka/consumer.rb +81 -76
- data/lib/rdkafka/defaults.rb +11 -2
- data/lib/rdkafka/error.rb +2 -1
- data/lib/rdkafka/helpers/oauth.rb +10 -5
- data/lib/rdkafka/native_kafka.rb +20 -7
- data/lib/rdkafka/producer/delivery_handle.rb +1 -2
- data/lib/rdkafka/producer/testing.rb +2 -1
- data/lib/rdkafka/producer.rb +28 -20
- data/lib/rdkafka/version.rb +1 -1
- data/lib/rdkafka.rb +10 -0
- data/package-lock.json +6 -6
- data/renovate.json +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bade2b0fd568e3141cf8f6eae85d0c8a047a50c20be28b6702a437ff2e1a01f5
|
|
4
|
+
data.tar.gz: bc6ae32429e7a8152e29edd606d88e6a8252218ba3d3abfe650442eef406a731
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7d17df3c107fe98ab8bf8fcb594ddf34ad2f06338b03c35e909b677246c1588763ccc19abc66f8a0c18ae9a36c840840758d6522aa55d155218a347ff33cf169
|
|
7
|
+
data.tar.gz: 56646addb2619b3e837be8a6d11e32fd0ce99ceee0662bd28b842ae22c3038208d5a69ad5ab702b7d5ec24621bae2cd3d495728a9ac68fa88b5fbed99577b34b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,43 +1,59 @@
|
|
|
1
1
|
# Rdkafka Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 0.28.2 (2026-09-11)
|
|
4
|
+
- [Fix] Close live clients from an `at_exit` hook before Ruby's shutdown finalization, so librdkafka is no longer `dlclose`d while its native threads are still running (which could segfault on exit). Ported from rdkafka-ruby (#964, Alex Selesse).
|
|
5
|
+
- [Fix] Make client construction exception-safe and destroy the native handle when setup fails after `rd_kafka_new`, so a later error no longer orphans the native client. Ported from rdkafka-ruby (#964, Alex Selesse).
|
|
6
|
+
- [Fix] Destroy each polled message exactly once in `Consumer#poll_batch`/`#poll_batch_nb` when building a message raises a non-`RdkafkaError`, fixing a double-free that could abort the process and closing the matching leak window. Ported from rdkafka-ruby (#973).
|
|
7
|
+
- [Fix] Free the background queue, `AdminOptions` and any already-built `ConfigResource`s (and remove the handle) when `Admin#describe_configs`/`#incremental_alter_configs` raise while building native resources (e.g. a non-String resource name). Ported from rdkafka-ruby (#973).
|
|
8
|
+
- [Fix] Raise a clear `ConfigError` instead of segfaulting when `Admin#describe_configs`/`#incremental_alter_configs` are given an empty resource name or a negative resource type (`rd_kafka_ConfigResource_new` returns NULL), or when `rd_kafka_AdminOptions_new` returns NULL. Ported from rdkafka-ruby (#973).
|
|
9
|
+
- [Fix] Allocate the topic-partition metadata string with a process-global malloc instead of an autorelease-off `FFI::MemoryPointer`, so the buffer handed to librdkafka is not freed under it. Ported from rdkafka-ruby (#969, Randy Stauner).
|
|
10
|
+
- [Maintenance] Bump the bundled OpenSSL used by the precompiled builds to `3.5.8` (LTS). Ported from rdkafka-ruby (#972, Scott Francis).
|
|
11
|
+
|
|
12
|
+
## v0.28.1 (2026-09-04)
|
|
13
|
+
- [Enhancement] Add `Admin#delete_records`, wrapping librdkafka's `DeleteRecords` admin API. Deletes all messages in a partition up to (but not including) a given offset - accepts an integer offset or `:end` to clear all current data. Ported from rdkafka-ruby (#956).
|
|
14
|
+
- [Enhancement] Add `Admin#list_consumer_groups`, wrapping librdkafka's `ListConsumerGroups` admin API. Returns a cluster-wide listing of consumer groups (`group_id`, `is_simple_consumer_group`, state) plus any per-broker errors. Ported from rdkafka-ruby (#955).
|
|
15
|
+
- [Fix] Make `NativeKafka#close` fork-aware so a forked child no longer segfaults on exit. Handles record their creator pid and skip the native teardown in any other process.
|
|
16
|
+
- [Fix] Stabilize the flaky partitions count cache statistics spec.
|
|
17
|
+
- [Fix] Stabilize the `to_native_tpl` leak integration spec against RSS measurement noise.
|
|
18
|
+
|
|
19
|
+
## v0.28.0 (2026-07-12)
|
|
4
20
|
- [Enhancement] Bump librdkafka to `2.14.2`. Maintenance release: fixes duplicate groups in `ListConsumerGroups` when multiple brokers return the same group, a data race in timers, and bumps bundled OpenSSL/libcurl/zstd/zlib/cJSON dependencies (several CVEs).
|
|
5
21
|
- [Enhancement] Add `Consumer#metadata` and `Producer#metadata`, mirroring `Admin#metadata`, so cluster/topic metadata can be fetched from an existing consumer or producer handle without opening a dedicated admin connection.
|
|
6
22
|
- [Enhancement] Name the failing partition and topic in the `RdkafkaError` raised for per-partition `list_offsets` errors (previously a bare error code), preserving the per-partition context the pre-batching `Consumer#lag` watermark errors carried.
|
|
7
|
-
- [Enhancement] Add `Consumer#list_offsets`, mirroring `Admin#list_offsets`, so
|
|
8
|
-
- [Enhancement] Extract the admin background-event result handlers into one class per operation under `lib/rdkafka/callbacks
|
|
9
|
-
- [Enhancement] Expose `replicas` and `isrs` (in-sync replica broker ids) on each partition in topic metadata
|
|
10
|
-
- [Enhancement] Reuse per-thread scratch pointers in `Consumer::Headers.from_native
|
|
11
|
-
- [Enhancement] Remove the unused `DeliveryHandle` `:topic_name` struct field and
|
|
12
|
-
- [Fix] Stop `poll_batch`/`poll_batch_nb` from discarding a whole batch when one message fails to build.
|
|
13
|
-
- [Fix] Add the missing `closed_consumer_check` to `Consumer#position
|
|
14
|
-
- [Fix] Stop leaking the native `rd_kafka_topic_conf_t` in `Producer#set_topic_config` when a per-topic config value is rejected.
|
|
15
|
-
- [Fix] Raise instead of silently dropping a rejected `incremental_alter_configs` entry
|
|
16
|
-
- [Fix] Let `PartitionsCountCache` adopt a lower partition count once the cached entry has expired
|
|
17
|
-
- [Fix] Make the `Consumer` GC finalizer close the consumer and destroy its consumer queue, not just the native client
|
|
18
|
-
- [Fix] Stop
|
|
19
|
-
- [Fix] Destroy the native topic-partition list in `TopicPartitionList#to_native_tpl` when population fails partway
|
|
20
|
-
- [Fix] Allocate the admin result-count out-parameter as `:size_t` instead of `:int32
|
|
21
|
-
- [Fix] Destroy admin API background events after processing
|
|
22
|
-
- [Fix] Resolve admin operation handles from the event error when an
|
|
23
|
-
- [Fix] Stop leaking the native `rd_kafka_conf_t` when client creation fails
|
|
24
|
-
- [Fix] Stop `Metadata` from leaking the native metadata struct
|
|
25
|
-
- [Fix] Free the librdkafka-allocated string in `Consumer#cluster_id` and `Consumer#member_id
|
|
26
|
-
- [Fix] Guard the message delivery callback so a raising user `delivery_callback` can no longer
|
|
27
|
-
- [Fix] Stop `Producer#produce` from orphaning the delivery handle in the process-global registry when it fails after registering it.
|
|
28
|
-
- [Fix] Attach `rd_kafka_query_watermark_offsets` with `blocking: true` so it releases the GVL
|
|
29
|
-
- [Fix] Stabilize the flaky `Consumer#lag`
|
|
30
|
-
- [Fix] Fix the NULL background-queue cleanup branches in `Admin#delete_group`, `Admin#delete_acl` and `Admin#describe_acl`, which
|
|
31
|
-
- [Fix] Forward `broker_message` and `instance_name` through `RdkafkaError.build
|
|
32
|
-
- [Fix] Synchronize `AbstractHandle::REGISTRY` mutations
|
|
33
|
-
- [Fix] Stop the `Metadata` retry loop from clobbering the request timeout and blocking for minutes.
|
|
34
|
-
- [Fix] Cache the partition count for a missing topic so `produce` with a `partition_key` to a not-yet-created topic no longer runs a blocking metadata query on every message.
|
|
23
|
+
- [Enhancement] Add `Consumer#list_offsets`, mirroring `Admin#list_offsets`, so offsets can be queried on an existing consumer handle without a dedicated admin connection, and rebuild `Consumer#lag` on top of it as one batched query instead of a roundtrip per partition.
|
|
24
|
+
- [Enhancement] Extract the admin background-event result handlers into one class per operation under `lib/rdkafka/callbacks/`. Internal reorganization with no API or behavior change.
|
|
25
|
+
- [Enhancement] Expose `replicas` and `isrs` (in-sync replica broker ids) on each partition in topic metadata; both were previously dropped from the `Metadata#topics` partition hashes.
|
|
26
|
+
- [Enhancement] Reuse per-thread scratch pointers in `Consumer::Headers.from_native`, removing the per-message native allocations from the consumer hot path.
|
|
27
|
+
- [Enhancement] Remove the unused `DeliveryHandle` `:topic_name` struct field and its per-message allocation. Use `DeliveryHandle#topic` or `DeliveryReport#topic_name`, both unchanged.
|
|
28
|
+
- [Fix] Stop `poll_batch`/`poll_batch_nb` from discarding a whole batch when one message fails to build. The failure is now surfaced inline as an `RdkafkaError` in the returned array, preserving the rest of the batch.
|
|
29
|
+
- [Fix] Add the missing `closed_consumer_check` to `Consumer#position`, so it raises a consistent `ClosedConsumerError` like every sibling offset method.
|
|
30
|
+
- [Fix] Stop leaking the native `rd_kafka_topic_conf_t` in `Producer#set_topic_config` when a per-topic config value is rejected.
|
|
31
|
+
- [Fix] Raise instead of silently dropping a rejected `incremental_alter_configs` entry, which previously left the alter request reporting success.
|
|
32
|
+
- [Fix] Let `PartitionsCountCache` adopt a lower partition count once the cached entry has expired, so a topic recreated with fewer partitions no longer fails `produce` until process restart.
|
|
33
|
+
- [Fix] Make the `Consumer` GC finalizer close the consumer and destroy its consumer queue, not just the native client, preventing a hang or leak when a consumer is collected without an explicit `close`.
|
|
34
|
+
- [Fix] Stop `describe_configs`, `incremental_alter_configs` and `list_offsets` from leaking handles and native resources when their arguments are rejected; all three now validate input before allocating.
|
|
35
|
+
- [Fix] Destroy the native topic-partition list in `TopicPartitionList#to_native_tpl` when population fails partway, which previously leaked the half-built list.
|
|
36
|
+
- [Fix] Allocate the admin result-count out-parameter as `:size_t` instead of `:int32`, fixing a 4-byte overflow on every admin result parse.
|
|
37
|
+
- [Fix] Destroy admin API background events after processing; they were never destroyed, so every admin operation leaked its whole result event. The internal FFI struct fields on admin handles were removed as part of this - use `handle.wait` and the returned report objects, whose interfaces are unchanged.
|
|
38
|
+
- [Fix] Resolve admin operation handles from the event error when an operation fails at the operation level (e.g. brokers unreachable), instead of blocking until `wait` timed out and discarding the real error.
|
|
39
|
+
- [Fix] Stop leaking the native `rd_kafka_conf_t` when client creation fails, a multi-KB leak per failed attempt for supervisors retrying on transient SASL/SSL misconfiguration.
|
|
40
|
+
- [Fix] Stop `Metadata` from leaking the native metadata struct on every retried fetch; each attempt now frees its own native resources.
|
|
41
|
+
- [Fix] Free the librdkafka-allocated string in `Consumer#cluster_id` and `Consumer#member_id`, and fix the `rd_kafka_clusterid` arity. `Consumer#cluster_id` now accepts a `timeout_ms`.
|
|
42
|
+
- [Fix] Guard the message delivery callback so a raising user `delivery_callback` can no longer leave the handle locked or crash the producer; exceptions are now logged and swallowed.
|
|
43
|
+
- [Fix] Stop `Producer#produce` from orphaning the delivery handle in the process-global registry when it fails after registering it.
|
|
44
|
+
- [Fix] Attach `rd_kafka_query_watermark_offsets` with `blocking: true` so it releases the GVL; it previously froze every other Ruby thread for up to `timeout_ms`.
|
|
45
|
+
- [Fix] Stabilize the flaky `Consumer#lag` spec on overloaded CI. Backported from rdkafka-ruby (#912).
|
|
46
|
+
- [Fix] Fix the NULL background-queue cleanup branches in `Admin#delete_group`, `Admin#delete_acl` and `Admin#describe_acl`, which raised a `NameError` and leaked the native request object instead of raising `ConfigError`.
|
|
47
|
+
- [Fix] Forward `broker_message` and `instance_name` through `RdkafkaError.build`; both were previously discarded on the `rd_kafka_error_t` pointer path.
|
|
48
|
+
- [Fix] Synchronize `AbstractHandle::REGISTRY` mutations with a mutex, which could otherwise lose a write on JRuby and leave a handle unregistered or leaked.
|
|
49
|
+
- [Fix] Stop the `Metadata` retry loop from clobbering the request timeout and blocking for minutes. The request timeout is left unchanged across retries, the backoff is capped, and the loop is bounded by a ~5s wall-clock budget after a floor of 3 attempts.
|
|
50
|
+
- [Fix] Cache the partition count for a missing topic, so `produce` with a `partition_key` to a not-yet-created topic no longer runs a blocking metadata query on every message.
|
|
35
51
|
|
|
36
52
|
## 0.27.2 (2026-05-21)
|
|
37
53
|
- [Enhancement] `poll_batch` and `poll_batch_nb` now return error events inline as `RdkafkaError` objects rather than raising on the first error. The return type is `Array<Message, RdkafkaError>` and callers are responsible for handling errors in the result.
|
|
38
54
|
|
|
39
55
|
## 0.27.1 (2026-05-14)
|
|
40
|
-
- [Fix] `poll_nb`, `poll_nb_each`, `poll_batch
|
|
56
|
+
- [Fix] `poll_nb`, `poll_nb_each`, `poll_batch` and `poll_batch_nb` now raise `RdkafkaError` with `details` populated (`{topic:, partition:, offset:}`) when a message contains an error, consistent with `poll`.
|
|
41
57
|
|
|
42
58
|
## 0.27.0 (2026-05-08)
|
|
43
59
|
- [Feature] Add `Consumer#poll_batch(timeout_ms, max_items:)` and `Consumer#poll_batch_nb(timeout_ms, max_items:)` for batch message polling via `rd_kafka_consume_batch_queue` (from upstream).
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Karafka-Rdkafka
|
|
2
2
|
|
|
3
|
-
[](https://github.com/karafka/karafka-rdkafka/actions/workflows/
|
|
3
|
+
[](https://github.com/karafka/karafka-rdkafka/actions/workflows/ci_linux_ubuntu_x86_64_gnu.yml)
|
|
4
4
|
[](https://badge.fury.io/rb/karafka-rdkafka)
|
|
5
5
|
[](https://slack.karafka.io)
|
|
6
6
|
|
|
@@ -61,14 +61,14 @@ Contributions should generally be made to the upstream [rdkafka-ruby repository]
|
|
|
61
61
|
|
|
62
62
|
## Versions
|
|
63
63
|
|
|
64
|
-
| rdkafka
|
|
64
|
+
| karafka-rdkafka | librdkafka | patches |
|
|
65
65
|
|-|-|-|
|
|
66
66
|
| 0.28.x (2026-07-12) | 2.14.2 (2026-06-03) | yes |
|
|
67
67
|
| 0.27.x (2026-05-08) | 2.14.1 (2026-04-15) | yes |
|
|
68
68
|
| 0.26.x (2026-04-11) | 2.14.0 (2026-04-01) | yes |
|
|
69
69
|
| 0.25.x (2026-04-02) | 2.13.2 (2026-03-02) | yes |
|
|
70
70
|
| 0.24.x (2026-02-25) | 2.13.0 (2026-01-05) | yes |
|
|
71
|
-
| 0.23.x (2025-11-01) | 2.12.1 (2025-10-
|
|
71
|
+
| 0.23.x (2025-11-01) | 2.12.1 (2025-10-21) | yes |
|
|
72
72
|
| 0.22.x (2025-09-26) | 2.11.1 (2025-08-18) | yes |
|
|
73
73
|
| 0.21.x (2025-08-18) | 2.11.0 (2025-07-03) | yes |
|
|
74
74
|
| 0.20.x (2025-07-17) | 2.8.0 (2025-01-07) | yes |
|
|
@@ -4,7 +4,8 @@ module Rdkafka
|
|
|
4
4
|
class Admin
|
|
5
5
|
# Report for create ACL operation result
|
|
6
6
|
class CreateAclReport
|
|
7
|
-
# Upon successful creation of Acl RD_KAFKA_RESP_ERR_NO_ERROR - 0 is returned as
|
|
7
|
+
# Upon successful creation of Acl RD_KAFKA_RESP_ERR_NO_ERROR - 0 is returned as
|
|
8
|
+
# rdkafka_response
|
|
8
9
|
# @return [Integer]
|
|
9
10
|
attr_reader :rdkafka_response
|
|
10
11
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Rdkafka
|
|
4
|
+
class Admin
|
|
5
|
+
# Handle for delete records operation
|
|
6
|
+
class DeleteRecordsHandle < AbstractHandle
|
|
7
|
+
layout :pending, :bool,
|
|
8
|
+
:response, :int
|
|
9
|
+
|
|
10
|
+
# @return [String] the name of the operation
|
|
11
|
+
def operation_name
|
|
12
|
+
"delete records"
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# @return [DeleteRecordsReport] report prepared by the background event callback, with the
|
|
16
|
+
# post-deletion low-watermark offsets (or per-partition errors)
|
|
17
|
+
def create_result
|
|
18
|
+
prepared_result
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Raises an error if the operation failed
|
|
22
|
+
# @raise [RdkafkaError]
|
|
23
|
+
def raise_error
|
|
24
|
+
raise RdkafkaError.new(
|
|
25
|
+
self[:response],
|
|
26
|
+
broker_message: broker_message
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Rdkafka
|
|
4
|
+
class Admin
|
|
5
|
+
# Report for delete records operation result
|
|
6
|
+
class DeleteRecordsReport
|
|
7
|
+
# Per-partition results. Each partition's `offset` is the post-deletion low-watermark (the
|
|
8
|
+
# smallest available offset of all live replicas) and its `err` carries the per-partition
|
|
9
|
+
# error code, if deletion failed for that partition.
|
|
10
|
+
# @return [Rdkafka::Consumer::TopicPartitionList]
|
|
11
|
+
attr_reader :offsets
|
|
12
|
+
|
|
13
|
+
# @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_DeleteRecords_result_t`
|
|
14
|
+
def initialize(result_ptr)
|
|
15
|
+
@offsets = Rdkafka::Consumer::TopicPartitionList.new
|
|
16
|
+
|
|
17
|
+
return if result_ptr.null?
|
|
18
|
+
|
|
19
|
+
native_tpl = Bindings.rd_kafka_DeleteRecords_result_offsets(result_ptr)
|
|
20
|
+
|
|
21
|
+
@offsets = Rdkafka::Consumer::TopicPartitionList.from_native_tpl(native_tpl)
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -4,7 +4,8 @@ module Rdkafka
|
|
|
4
4
|
class Admin
|
|
5
5
|
# Report for describe ACL operation result
|
|
6
6
|
class DescribeAclReport
|
|
7
|
-
# acls that exists in the cluster for the resource_type, resource_name and pattern_type
|
|
7
|
+
# acls that exists in the cluster for the resource_type, resource_name and pattern_type
|
|
8
|
+
# filters provided in the request.
|
|
8
9
|
# @return [Rdkafka::Bindings::AclBindingResult] array of matching acls.
|
|
9
10
|
attr_reader :acls
|
|
10
11
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Rdkafka
|
|
4
|
+
class Admin
|
|
5
|
+
# Handle for list consumer groups operation
|
|
6
|
+
class ListConsumerGroupsHandle < AbstractHandle
|
|
7
|
+
layout :pending, :bool,
|
|
8
|
+
:response, :int
|
|
9
|
+
|
|
10
|
+
# @return [String] the name of the operation
|
|
11
|
+
def operation_name
|
|
12
|
+
"list consumer groups"
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# @return [ListConsumerGroupsReport] report prepared by the background event callback, with
|
|
16
|
+
# the listed consumer groups.
|
|
17
|
+
def create_result
|
|
18
|
+
prepared_result
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Raises an error if the operation failed
|
|
22
|
+
# @raise [RdkafkaError]
|
|
23
|
+
def raise_error
|
|
24
|
+
raise RdkafkaError.new(
|
|
25
|
+
self[:response],
|
|
26
|
+
broker_message: broker_message
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Rdkafka
|
|
4
|
+
class Admin
|
|
5
|
+
# Report for list consumer groups operation result
|
|
6
|
+
class ListConsumerGroupsReport
|
|
7
|
+
# Consumer groups listed cluster-wide. Each entry is a hash with:
|
|
8
|
+
# - `:group_id` [String] the consumer group id
|
|
9
|
+
# - `:is_simple_consumer_group` [Boolean] `true` for a "simple" consumer group - one that
|
|
10
|
+
# assigns partitions manually (via `assign`) and uses Kafka only for offset storage,
|
|
11
|
+
# rather than joining the group-management protocol and letting Kafka assign partitions
|
|
12
|
+
# and rebalance automatically (`subscribe`). Simple groups have no members from the
|
|
13
|
+
# broker's point of view, so they never rebalance.
|
|
14
|
+
# - `:state` [Integer] the group state as a `Bindings::RD_KAFKA_CONSUMER_GROUP_STATE_*`
|
|
15
|
+
# code, one of: `RD_KAFKA_CONSUMER_GROUP_STATE_UNKNOWN`,
|
|
16
|
+
# `RD_KAFKA_CONSUMER_GROUP_STATE_PREPARING_REBALANCE`,
|
|
17
|
+
# `RD_KAFKA_CONSUMER_GROUP_STATE_COMPLETING_REBALANCE`,
|
|
18
|
+
# `RD_KAFKA_CONSUMER_GROUP_STATE_STABLE`, `RD_KAFKA_CONSUMER_GROUP_STATE_DEAD`,
|
|
19
|
+
# `RD_KAFKA_CONSUMER_GROUP_STATE_EMPTY`
|
|
20
|
+
# - `:state_name` [String] human-readable name of that state (e.g. `"Stable"`, `"Empty"`)
|
|
21
|
+
# @return [Array<Hash>]
|
|
22
|
+
attr_reader :groups
|
|
23
|
+
|
|
24
|
+
# Per-broker errors reported alongside the (partial) group listing. `ListConsumerGroups`
|
|
25
|
+
# fans out to every broker and returns valid groups and errors separately, so a broker
|
|
26
|
+
# being unreachable does not discard the groups the reachable brokers returned.
|
|
27
|
+
# @return [Array<RdkafkaError>]
|
|
28
|
+
attr_reader :errors
|
|
29
|
+
|
|
30
|
+
# @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_ListConsumerGroups_result_t`
|
|
31
|
+
def initialize(result_ptr)
|
|
32
|
+
@groups = []
|
|
33
|
+
@errors = []
|
|
34
|
+
|
|
35
|
+
return if result_ptr.null?
|
|
36
|
+
|
|
37
|
+
extract_groups(result_ptr)
|
|
38
|
+
extract_errors(result_ptr)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
private
|
|
42
|
+
|
|
43
|
+
# @param result_ptr [FFI::Pointer] pointer to the result
|
|
44
|
+
def extract_groups(result_ptr)
|
|
45
|
+
count_ptr = FFI::MemoryPointer.new(:size_t)
|
|
46
|
+
array_ptr = Bindings.rd_kafka_ListConsumerGroups_result_valid(result_ptr, count_ptr)
|
|
47
|
+
|
|
48
|
+
return if array_ptr.null?
|
|
49
|
+
|
|
50
|
+
array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |listing_ptr|
|
|
51
|
+
state = Bindings.rd_kafka_ConsumerGroupListing_state(listing_ptr)
|
|
52
|
+
group_id_ptr = Bindings.rd_kafka_ConsumerGroupListing_group_id(listing_ptr)
|
|
53
|
+
state_name_ptr = Bindings.rd_kafka_consumer_group_state_name(state)
|
|
54
|
+
|
|
55
|
+
@groups << {
|
|
56
|
+
group_id: group_id_ptr.null? ? nil : group_id_ptr.read_string,
|
|
57
|
+
is_simple_consumer_group:
|
|
58
|
+
Bindings.rd_kafka_ConsumerGroupListing_is_simple_consumer_group(listing_ptr) != 0,
|
|
59
|
+
state: state,
|
|
60
|
+
state_name: state_name_ptr.null? ? nil : state_name_ptr.read_string
|
|
61
|
+
}
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# @param result_ptr [FFI::Pointer] pointer to the result
|
|
66
|
+
def extract_errors(result_ptr)
|
|
67
|
+
count_ptr = FFI::MemoryPointer.new(:size_t)
|
|
68
|
+
array_ptr = Bindings.rd_kafka_ListConsumerGroups_result_errors(result_ptr, count_ptr)
|
|
69
|
+
|
|
70
|
+
return if array_ptr.null?
|
|
71
|
+
|
|
72
|
+
array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |error_ptr|
|
|
73
|
+
string_ptr = Bindings.rd_kafka_error_string(error_ptr)
|
|
74
|
+
|
|
75
|
+
@errors << RdkafkaError.new(
|
|
76
|
+
Bindings.rd_kafka_error_code(error_ptr),
|
|
77
|
+
broker_message: string_ptr.null? ? nil : string_ptr.read_string
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
end
|