com.opendxl.databus.consumer

Interface ConsumerRebalanceListener

All Known Implementing Classes:

NoOpConsumerRebalanceListener

public interface ConsumerRebalanceListener

A callback interface that the user can implement to trigger custom actions when the set of partitions assigned to the consumer changes.

This is applicable when the consumer is having Kafka auto-manage group membership. If the consumer's directly assign partitions, those partitions will never be reassigned and this callback is not applicable.

When Kafka is managing the group membership, a partition re-assignment will be triggered any time the members of the group changes or the subscription of the members changes. This can occur when processes die, new process instances are added or old instances come back to life after failure. Rebalances can also be triggered by changes affecting the subscribed topics (e.g. when then number of partitions is administratively adjusted).

There are many uses for this functionality. One common use is saving offsets in a custom store. By saving offsets in the onPartitionsRevoked(Collection), call we can ensure that any time partition assignment changes the offset gets saved.

Another use is flushing out any kind of cache of intermediate results the consumer may be keeping. For example, consider a case where the consumer is subscribed to a topic containing user page views, and the goal is to count the number of page views per users for each five minute window. Let's say the topic is partitioned by the user id so that all events for a particular user will go to a single consumer getInstance. The consumer can keep in memory a running tally of actions per user and only flush these out to a remote data store when its cache gets to big. However if a partition is reassigned it may want to automatically trigger a flush of this cache, before the new owner takes over consumption.

This callback will execute in the user thread as part of the poll(long) call whenever partition assignment changes.

It is guaranteed that all consumer processes will invoke onPartitionsRevoked prior to any process invoking onPartitionsAssigned. So if offsets or other state is saved in the onPartitionsRevoked call it is guaranteed to be saved by the time the process taking over that partition has their onPartitionsAssigned callback called to load the state.

Here is pseudo-code for a callback implementation for saving offsets:

 
   public class SaveOffsetsOnRebalance implements ConsumerRebalanceListener {
       private DatabusConsumer consumer;

       public SaveOffsetsOnRebalance(DatabusConsumer consumer) {
           this.consumer = consumer;
       }

       public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
           // save the offsets in an external store using some custom code not described here
           for(TopicPartition partition: partitions)
              saveOffsetInExternalStore(consumer.position(partition));
       }

       public void onPartitionsAssigned(Collection<TopicPartition> partitions) {
           // read the offsets from an external store using some custom code not described here
           for(TopicPartition partition: partitions)
              consumer.seek(partition, readOffsetFromExternalStore(partition));
       }
   }
 
 

Method Summary

Modifier and Type	Method and Description
void	onPartitionsAssigned(java.util.Collection<TopicPartition> partitions) A callback method the user can implement to provide handling of customized offsets on completion of a successful partition re-assignment.
void	onPartitionsRevoked(java.util.Collection<TopicPartition> partitions) A callback method the user can implement to provide handling of offset commits to a customized store on the start of a rebalance operation.

Method Detail

onPartitionsRevoked

void onPartitionsRevoked(java.util.Collection<TopicPartition> partitions)

A callback method the user can implement to provide handling of offset commits to a customized store on the start of a rebalance operation. This method will be called before a rebalance operation starts and after the consumer stops fetching data. It is recommended that offsets should be committed in this callback to either Kafka or a custom offset store to prevent duplicate data.

For examples on usage of this API, see Usage Examples section of Consumer

NOTE: This method is only called before rebalances. It is not called prior to Consumer.close().

Parameters:

partitions - The list of partitions that were assigned to the consumer on the last rebalance

onPartitionsAssigned

void onPartitionsAssigned(java.util.Collection<TopicPartition> partitions)

A callback method the user can implement to provide handling of customized offsets on completion of a successful partition re-assignment. This method will be called after an offset re-assignment completes and before the consumer starts fetching data.

It is guaranteed that all the processes in a consumer group will execute their onPartitionsRevoked(Collection) callback before any getInstance executes its onPartitionsAssigned(Collection) callback.

Parameters:

partitions - The list of partitions that are now assigned to the consumer (may include partitions previously assigned to the consumer)