org.apache.kafka.clients.consumer

Class CooperativeStickyAssignor

java.lang.Object

org.apache.kafka.clients.consumer.internals.AbstractPartitionAssignor

org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

org.apache.kafka.clients.consumer.CooperativeStickyAssignor

All Implemented Interfaces:

ConsumerPartitionAssignor

public class CooperativeStickyAssignor
extends org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

A cooperative version of the AbstractStickyAssignor. This follows the same (sticky) assignment logic as StickyAssignor but allows for cooperative rebalancing while the StickyAssignor follows the eager rebalancing protocol. See ConsumerPartitionAssignor.RebalanceProtocol for an explanation of the rebalancing protocols.

Users should prefer this assignor for newer clusters.

To turn on cooperative rebalancing you must set all your consumers to use this PartitionAssignor, or implement a custom one that returns RebalanceProtocol.COOPERATIVE in supportedProtocols().

IMPORTANT: if upgrading from 2.3 or earlier, you must follow a specific upgrade path in order to safely turn on cooperative rebalancing. See the upgrade guide for details.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor.MemberData

Nested classes/interfaces inherited from class org.apache.kafka.clients.consumer.internals.AbstractPartitionAssignor

org.apache.kafka.clients.consumer.internals.AbstractPartitionAssignor.MemberInfo

Nested classes/interfaces inherited from interface org.apache.kafka.clients.consumer.ConsumerPartitionAssignor

ConsumerPartitionAssignor.Assignment, ConsumerPartitionAssignor.GroupAssignment, ConsumerPartitionAssignor.GroupSubscription, ConsumerPartitionAssignor.RebalanceProtocol, ConsumerPartitionAssignor.Subscription

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COOPERATIVE_STICKY_ASSIGNOR_NAME

Fields inherited from class org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

DEFAULT_GENERATION, partitionsTransferringOwnership

Constructor Summary

Constructors

Constructor and Description
CooperativeStickyAssignor()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<TopicPartition>>	assign(java.util.Map<java.lang.String,java.lang.Integer> partitionsPerTopic, java.util.Map<java.lang.String,ConsumerPartitionAssignor.Subscription> subscriptions)
protected org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor.MemberData	memberData(ConsumerPartitionAssignor.Subscription subscription)
java.lang.String	name() Unique name for this assignor (e.g.
void	onAssignment(ConsumerPartitionAssignor.Assignment assignment, ConsumerGroupMetadata metadata) Callback which is invoked when a group member receives its assignment from the leader.
java.nio.ByteBuffer	subscriptionUserData(java.util.Set<java.lang.String> topics) Return serialized data that will be included in the ConsumerPartitionAssignor.Subscription sent to the leader and can be leveraged in ConsumerPartitionAssignor.assign(Cluster, GroupSubscription) ((e.g.
java.util.List<ConsumerPartitionAssignor.RebalanceProtocol>	supportedProtocols() Indicate which rebalance protocol this assignor works with; By default it should always work with ConsumerPartitionAssignor.RebalanceProtocol.EAGER.

Methods inherited from class org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

isSticky

Methods inherited from class org.apache.kafka.clients.consumer.internals.AbstractPartitionAssignor

assign, partitions, put

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.kafka.clients.consumer.ConsumerPartitionAssignor

version

Field Detail

COOPERATIVE_STICKY_ASSIGNOR_NAME

public static final java.lang.String COOPERATIVE_STICKY_ASSIGNOR_NAME

See Also:

Constant Field Values

Constructor Detail

CooperativeStickyAssignor

public CooperativeStickyAssignor()

Method Detail

name

public java.lang.String name()

Description copied from interface: ConsumerPartitionAssignor

Unique name for this assignor (e.g. "range" or "roundrobin" or "sticky"). Note, this is not required to be the same as the class name specified in ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG

Returns:

non-null unique name

supportedProtocols

public java.util.List<ConsumerPartitionAssignor.RebalanceProtocol> supportedProtocols()

Description copied from interface: ConsumerPartitionAssignor

Indicate which rebalance protocol this assignor works with; By default it should always work with ConsumerPartitionAssignor.RebalanceProtocol.EAGER.

onAssignment

public void onAssignment(ConsumerPartitionAssignor.Assignment assignment,
                         ConsumerGroupMetadata metadata)

Description copied from interface: ConsumerPartitionAssignor

Callback which is invoked when a group member receives its assignment from the leader.

Parameters:

assignment - The local member's assignment as provided by the leader in ConsumerPartitionAssignor.assign(Cluster, GroupSubscription)

metadata - Additional metadata on the consumer (optional)

subscriptionUserData

public java.nio.ByteBuffer subscriptionUserData(java.util.Set<java.lang.String> topics)

Description copied from interface: ConsumerPartitionAssignor

Return serialized data that will be included in the ConsumerPartitionAssignor.Subscription sent to the leader and can be leveraged in ConsumerPartitionAssignor.assign(Cluster, GroupSubscription) ((e.g. local host/rack information)

Parameters:

topics - Topics subscribed to through KafkaConsumer.subscribe(java.util.Collection) and variants

Returns:

nullable subscription user data

memberData

protected org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor.MemberData memberData(ConsumerPartitionAssignor.Subscription subscription)

Specified by:

memberData in class org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor

assign

public java.util.Map<java.lang.String,java.util.List<TopicPartition>> assign(java.util.Map<java.lang.String,java.lang.Integer> partitionsPerTopic,
                                                                             java.util.Map<java.lang.String,ConsumerPartitionAssignor.Subscription> subscriptions)

Overrides:

assign in class org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor