Package org.graylog2.outputs

Class BatchedMessageFilterOutput

java.lang.Object

org.graylog2.outputs.BatchedMessageFilterOutput

All Implemented Interfaces:

MessageOutput, Stoppable, GracefulShutdownHook

@Singleton
public class BatchedMessageFilterOutput
extends Object
implements MessageOutput, GracefulShutdownHook

A message output that filters incoming messages and writes batches of filtered messages to all registered FilteredMessageOutput outputs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graylog2.plugin.outputs.MessageOutput

MessageOutput.Config, MessageOutput.Descriptor, MessageOutput.Factory<T>, MessageOutput.Factory2<T>

Constructor Summary

Constructors

Constructor

Description

BatchedMessageFilterOutput(Map<String,FilteredMessageOutput> outputs, OutputFilter outputFilter, com.codahale.metrics.MetricRegistry metricRegistry, Cluster cluster, MessageQueueAcknowledger acknowledger, IndexSetAwareMessageOutputBuffer indexSetAwareMessageOutputBuffer, GracefulShutdownService gracefulShutdownService, int outputFlushInterval, int shutdownTimeoutMs, ScheduledExecutorService daemonScheduler)

Method Summary

Modifier and Type	Method	Description
void	doGracefulShutdown()	Execute shutdown tasks for the service that implements this interface.
void	initialize()	Initialize output, if not done in the constructor.
boolean	isRunning()
void	stop()
void	write(List<Message> messages)
void	write(Message message)

Methods inherited from class java.lang.Object

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

Constructor Details

BatchedMessageFilterOutput

@Inject
public BatchedMessageFilterOutput(Map<String,FilteredMessageOutput> outputs,
 OutputFilter outputFilter,
 com.codahale.metrics.MetricRegistry metricRegistry,
 Cluster cluster,
 MessageQueueAcknowledger acknowledger,
 IndexSetAwareMessageOutputBuffer indexSetAwareMessageOutputBuffer,
 GracefulShutdownService gracefulShutdownService,
 @Named("output_flush_interval")
 int outputFlushInterval,
 @Named("shutdown_timeout")
 int shutdownTimeoutMs,
 @Named("daemonScheduler")
 ScheduledExecutorService daemonScheduler)

Method Details

initialize

public void initialize()
                throws Exception

Description copied from interface: MessageOutput

Initialize output, if not done in the constructor. Allows for graceful handling of initialization failures, e.g. because of an insufficient license. The output-launching code will call this method right after constructing the output instance.

Specified by:

initialize in interface MessageOutput

Throws:

InsufficientLicenseException - if the output could not be initialized due to an insufficient license.

Exception

isRunning

public boolean isRunning()

Specified by:

isRunning in interface MessageOutput

write

public void write(List<Message> messages)
           throws Exception

Specified by:

write in interface MessageOutput

Throws:

Exception

write

public void write(Message message)
           throws Exception

Specified by:

write in interface MessageOutput

Throws:

Exception

stop

public void stop()

Specified by:

stop in interface Stoppable

doGracefulShutdown

public void doGracefulShutdown()

Description copied from interface: GracefulShutdownHook

Execute shutdown tasks for the service that implements this interface.

Warning:

• This method is called from another thread so the class that implements GracefulShutdownHook must be thread-safe.
• The server shutdown is waiting for this method call to complete. Blocking this method will block the server shutdown!

Specified by:

doGracefulShutdown in interface GracefulShutdownHook