org.graylog2.plugin.inputs.transports

Class ThrottleableTransport

java.lang.Object

org.graylog2.plugin.inputs.transports.ThrottleableTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

AmqpTransport, GeneratorTransport, HttpPollTransport, KafkaTransport

public abstract class ThrottleableTransport
extends Object
implements Transport

Placeholder class for implementing logic to throttle certain transports which support back pressure. The built in transports that support this by reading less are the Kafka and AMQP transports.
Empty for now, since the process buffer provides natural throttling for now, but once that is async we need to supply back pressure in some other way.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThrottleableTransport.Config

Nested classes/interfaces inherited from interface org.graylog2.plugin.inputs.transports.Transport

Transport.Factory<T extends Transport>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CK_THROTTLING_ALLOWED

Constructor Summary

Constructors

Constructor and Description
ThrottleableTransport(com.google.common.eventbus.EventBus eventBus, Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	blockUntilUnthrottled() Blocks until the blockLatch is released.
boolean	blockUntilUnthrottled(long timeout, TimeUnit unit) Blocks until the blockLatch is released or until the timeout is exceeded.
protected boolean	determineIfThrottled(ThrottleState state) This method implements the default algorithm for determining whether a transport will be throttled or not.
protected abstract void	doLaunch(MessageInput input) Performs the same purpose as launch(org.graylog2.plugin.inputs.MessageInput) but guarantees that the superclass' actions are performed.
protected abstract void	doStop() Performs the same purpose as stop() but guarantees that the superclass' actions are performed.
void	handleChangedThrottledState(boolean isThrottled) Transports can override this to be notified when the throttled state changes.
boolean	isThrottled()
void	launch(MessageInput input)
void	stop()
void	updateThrottleState(ThrottleState throttleState) Only executed if the Allow Throttling checkbox is set in the input's configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.plugin.inputs.transports.Transport

getMetricSet, setMessageAggregator

Field Detail

CK_THROTTLING_ALLOWED

public static final String CK_THROTTLING_ALLOWED

See Also:

Constant Field Values

Constructor Detail

ThrottleableTransport

public ThrottleableTransport(com.google.common.eventbus.EventBus eventBus,
                             Configuration configuration)

Method Detail

launch

public void launch(MessageInput input)
            throws MisfireException

Specified by:

launch in interface Transport

Throws:

MisfireException

doLaunch

protected abstract void doLaunch(MessageInput input)
                          throws MisfireException

Performs the same purpose as launch(org.graylog2.plugin.inputs.MessageInput) but guarantees that the superclass' actions are performed.

Parameters:

input -

Throws:

MisfireException

stop

public void stop()

Specified by:

stop in interface Transport

doStop

protected abstract void doStop()

Performs the same purpose as stop() but guarantees that the superclass' actions are performed.

updateThrottleState

public void updateThrottleState(ThrottleState throttleState)

Only executed if the Allow Throttling checkbox is set in the input's configuration.

Parameters:

throttleState - current processing system state

handleChangedThrottledState

public void handleChangedThrottledState(boolean isThrottled)

Transports can override this to be notified when the throttled state changes. Only called when throttled state changes.

Parameters:

isThrottled - the current throttled state.

isThrottled

public boolean isThrottled()

determineIfThrottled

protected boolean determineIfThrottled(ThrottleState state)

This method implements the default algorithm for determining whether a transport will be throttled or not.

Override this method in your subclass if you need to customize the decision.

If the transport was started without the throttling_allowed flag enabled, this method will not be called!

Parameters:

state - the current state of the processing system

Returns:

true if transport should be throttled, false if not.

blockUntilUnthrottled

public void blockUntilUnthrottled()

Blocks until the blockLatch is released.

blockUntilUnthrottled

public boolean blockUntilUnthrottled(long timeout,
                                     TimeUnit unit)

Blocks until the blockLatch is released or until the timeout is exceeded.

Parameters:

timeout - the maximum time to wait

unit - the time unit for the timeout argument.

Returns:

true if the blockLatch was released before the timeout elapsed. and false if the timeout was exceeded before the blockLatch was released.