ruby-kafka 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f2b126f35425a1fde1e65ae5cac8d8e969416c77c00002a6eac744b23f91bf
-  data.tar.gz: 07dfce70a3e142e4e1efe95fa089466f7d8dd2200f8e25787b9f917b2b6084ff
+  metadata.gz: b311a24cc8c5a81b7f0e7f930f4e0d28488d14ecaec2456ca482ac86889c3344
+  data.tar.gz: 8315a0b6b22bb4b7ef9393af789101508091b84ae895fb3a80250ba68ce61118
 SHA512:
-  metadata.gz: 247ada1eb577419262b6d50aa82b3a39fadcd34e0fad625002786f50e26082c06f13d62ff69ec5a4f0c4791d10a922895e3af179ef38d2cf08e8621171966c03
-  data.tar.gz: 5b12bcb7277c39ba03308074b6f0998019f4535a8484275b4b19614e7b9bca539f4e14a9edb8eea1b82439d872deec362c5305034d6d7c4d9b1bdb475025dd2b
+  metadata.gz: 7f1e7818c5276401f556a093e746c811d13f31c056d0c9f415bd5ef91ce38bbe50b7f9b1849ed5529c9e3e134261d147a89e27d10f31d268d8bb1e6335178a17
+  data.tar.gz: 5d79aa51abd414624f79e1f6d64a110ff57ee0adb289503a2862d383b1b9e73344718224d93f54fef0f59ffda004a845111626cb03b9c8d8623a47797159afc7

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Changes and additions to the library will be listed here.
 
 ## Unreleased
 
+- Add support for the Describe Groups API (#583).
+
+## v0.6.2
+
 - Add list groups API (#582).
 - Use mutable String constructor (#584).
 

data/lib/kafka/broker.rb

@@ -158,6 +158,12 @@ module Kafka
       send_request(request)
     end
 
+    def describe_groups(**options)
+      request = Protocol::DescribeGroupsRequest.new(**options)
+
+      send_request(request)
+    end
+
     private
 
     def send_request(request)

data/lib/kafka/client.rb

@@ -277,8 +277,19 @@ module Kafka
     #   than the session window.
     # @param offset_retention_time [Integer] the time period that committed
     #   offsets will be retained, in seconds. Defaults to the broker setting.
+    # @param fetcher_max_queue_size [Integer] max number of items in the fetch queue that
+    #   are stored for further processing. Note, that each item in the queue represents a
+    #   response from a single broker.
     # @return [Consumer]
-    def consumer(group_id:, session_timeout: 30, offset_commit_interval: 10, offset_commit_threshold: 0, heartbeat_interval: 10, offset_retention_time: nil)
+    def consumer(
+        group_id:,
+        session_timeout: 30,
+        offset_commit_interval: 10,
+        offset_commit_threshold: 0,
+        heartbeat_interval: 10,
+        offset_retention_time: nil,
+        fetcher_max_queue_size: 100
+    )
       cluster = initialize_cluster
 
       instrumenter = DecoratingInstrumenter.new(@instrumenter, {
@@ -301,6 +312,7 @@ module Kafka
         cluster: initialize_cluster,
         logger: @logger,
         instrumenter: instrumenter,
+        max_queue_size: fetcher_max_queue_size
       )
 
       offset_manager = OffsetManager.new(
@@ -540,6 +552,14 @@ module Kafka
       @cluster.alter_topic(name, configs)
     end
 
+    # Describe a consumer group
+    #
+    # @param group_id [String] the id of the consumer group
+    # @return [Kafka::Protocol::DescribeGroupsResponse::Group]
+    def describe_group(group_id)
+      @cluster.describe_group(group_id)
+    end
+
     # Create partitions for a topic.
     #
     # @param name [String] the name of the topic.

data/lib/kafka/cluster.rb

@@ -255,6 +255,13 @@ module Kafka
       nil
     end
 
+    def describe_group(group_id)
+      response = get_group_coordinator(group_id: group_id).describe_groups(group_ids: [group_id])
+      group = response.groups.first
+      Protocol.handle_error(group.error_code)
+      group
+    end
+
     def create_partitions_for(name, num_partitions:, timeout:)
       options = {
         topics: [[name, num_partitions, nil]],

data/lib/kafka/fetcher.rb

@@ -4,14 +4,13 @@ require "kafka/fetch_operation"
 
 module Kafka
   class Fetcher
-    MAX_QUEUE_SIZE = 100
-
     attr_reader :queue
 
-    def initialize(cluster:, logger:, instrumenter:)
+    def initialize(cluster:, logger:, instrumenter:, max_queue_size:)
       @cluster = cluster
       @logger = logger
       @instrumenter = instrumenter
+      @max_queue_size = max_queue_size
 
       @queue = Queue.new
       @commands = Queue.new
@@ -89,10 +88,10 @@ module Kafka
         send("handle_#{cmd}", *args)
       elsif !@running
         sleep 0.1
-      elsif @queue.size < MAX_QUEUE_SIZE
+      elsif @queue.size < @max_queue_size
         step
       else
-        @logger.warn "Reached max fetcher queue size (#{MAX_QUEUE_SIZE}), sleeping 1s"
+        @logger.warn "Reached max fetcher queue size (#{@max_queue_size}), sleeping 1s"
         sleep 1
       end
     end

data/lib/kafka/protocol.rb

@@ -25,6 +25,7 @@ module Kafka
     HEARTBEAT_API = 12
     LEAVE_GROUP_API = 13
     SYNC_GROUP_API = 14
+    DESCRIBE_GROUPS_API = 15
     LIST_GROUPS_API = 16
     SASL_HANDSHAKE_API = 17
     API_VERSIONS_API = 18
@@ -180,3 +181,5 @@ require "kafka/protocol/create_partitions_request"
 require "kafka/protocol/create_partitions_response"
 require "kafka/protocol/list_groups_request"
 require "kafka/protocol/list_groups_response"
+require "kafka/protocol/describe_groups_request"
+require "kafka/protocol/describe_groups_response"

data/lib/kafka/protocol/describe_groups_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kafka
+  module Protocol
+    class DescribeGroupsRequest
+      def initialize(group_ids:)
+        @group_ids = group_ids
+      end
+
+      def api_key
+        DESCRIBE_GROUPS_API
+      end
+
+      def api_version
+        0
+      end
+
+      def response_class
+        Protocol::DescribeGroupsResponse
+      end
+
+      def encode(encoder)
+        encoder.write_array(@group_ids) { |group_id| encoder.write_string(group_id) }
+      end
+    end
+  end
+end

data/lib/kafka/protocol/describe_groups_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Kafka
+  module Protocol
+    class DescribeGroupsResponse
+      class Group
+        attr_reader :error_code, :group_id, :state, :members, :protocol
+
+        def initialize(error_code:, group_id:, protocol_type:, protocol:, state:, members:)
+          @error_code = error_code
+          @group_id = group_id
+          @protocol_type = protocol_type
+          @protocol = protocol
+          @state = state
+          @members = members
+        end
+      end
+
+      class Member
+        attr_reader :member_id, :client_id, :client_host, :member_assignment
+
+        def initialize(member_id:, client_id:, client_host:, member_assignment:)
+          @member_id = member_id
+          @client_id = client_id
+          @client_host = client_host
+          @member_assignment = member_assignment
+        end
+      end
+
+      attr_reader :error_code, :groups
+
+      def initialize(groups:)
+        @groups = groups
+      end
+
+      def self.decode(decoder)
+        groups = decoder.array do
+          error_code = decoder.int16
+          group_id = decoder.string
+          state = decoder.string
+          protocol_type = decoder.string
+          protocol = decoder.string
+
+          members = decoder.array do
+            member_id = decoder.string
+            client_id = decoder.string
+            client_host = decoder.string
+            metadata = decoder.bytes
+            assignment = MemberAssignment.decode(Decoder.from_string(decoder.bytes))
+
+            Member.new(
+              member_id: member_id,
+              client_id: client_id,
+              client_host: client_host,
+              member_assignment: assignment
+            )
+          end
+
+          Group.new(
+            error_code: error_code,
+            group_id: group_id,
+            state: state,
+            protocol_type: protocol_type,
+            protocol: protocol,
+            members: members
+          )
+        end
+
+        new(groups: groups)
+      end
+    end
+  end
+end

data/lib/kafka/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kafka
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-kafka
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -351,6 +351,8 @@ files:
 - lib/kafka/protocol/delete_topics_response.rb
 - lib/kafka/protocol/describe_configs_request.rb
 - lib/kafka/protocol/describe_configs_response.rb
+- lib/kafka/protocol/describe_groups_request.rb
+- lib/kafka/protocol/describe_groups_response.rb
 - lib/kafka/protocol/encoder.rb
 - lib/kafka/protocol/fetch_request.rb
 - lib/kafka/protocol/fetch_response.rb