org.apache.flume.channel

Class LoadBalancingChannelSelector

java.lang.Object

org.apache.flume.channel.AbstractChannelSelector

org.apache.flume.channel.LoadBalancingChannelSelector

All Implemented Interfaces:

ChannelSelector, Configurable, NamedComponent

public class LoadBalancingChannelSelector
extends AbstractChannelSelector

Load balancing channel selector. This selector allows for load balancing between channels based on various policy configuration options. This serves a similar purpose to the LoadBalancingSinkProcessor except it allows the sinks to run in their own threads instead of in just one.

The LoadBalancingChannelSelector maintains an indexed list of active channels on which the load must be distributed. This implementation supports distributing load using either via ROUND_ROBIN or via RANDOM selection mechanism. The choice of selection mechanism defaults to ROUND_ROBIN type, but can be overridden via configuration.

Constructor Summary

Constructors

Constructor and Description
LoadBalancingChannelSelector()

Method Summary

Modifier and Type	Method and Description
void	configure(Context context) Request the implementing class to (re)configure itself.
List<Channel>	getOptionalChannels(Event event) Returns a list of optional channels.
List<Channel>	getRequiredChannels(Event event) Returns a list of required channels.

Methods inherited from class org.apache.flume.channel.AbstractChannelSelector

getAllChannels, getChannelListFromNames, getChannelNameMap, getName, setChannels, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadBalancingChannelSelector

public LoadBalancingChannelSelector()

Method Detail

getRequiredChannels

public List<Channel> getRequiredChannels(Event event)

Description copied from interface: ChannelSelector

Returns a list of required channels. A failure in writing the event to these channels must be communicated back to the source that received this event.

Returns:

the list of required channels that this selector has selected for the given event.

getOptionalChannels

public List<Channel> getOptionalChannels(Event event)

Description copied from interface: ChannelSelector

Returns a list of optional channels. A failure in writing the event to these channels must be ignored.

Returns:

the list of optional channels that this selector has selected for the given event.

configure

public void configure(Context context)

Description copied from interface: Configurable

Request the implementing class to (re)configure itself.

When configuration parameters are changed, they must be reflected by the component asap.

There are no thread safety guarantees on when configure might be called.