org.graylog.plugins.pipelineprocessor.processors

Class PipelineInterpreter

java.lang.Object

org.graylog.plugins.pipelineprocessor.processors.PipelineInterpreter

All Implemented Interfaces:

MessageProcessor

public class PipelineInterpreter
extends Object
implements MessageProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineInterpreter.Descriptor
static class	PipelineInterpreter.State

Constructor Summary

Constructors

Constructor and Description
PipelineInterpreter(MessageQueueAcknowledger messageQueueAcknowledger, com.codahale.metrics.MetricRegistry metricRegistry, ConfigurationStateUpdater stateUpdater)

Method Summary

Modifier and Type	Method and Description
Messages	process(Messages messages)
Messages	process(Messages messages, InterpreterListener interpreterListener, PipelineInterpreter.State state) Evaluates all pipelines that apply to the given messages, based on the current stream routing of the messages.
List<Message>	processForPipelines(Message message, Set<String> pipelineIds, InterpreterListener interpreterListener, PipelineInterpreter.State state) Given a set of pipeline ids, process the given message according to the passed state.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineInterpreter

@Inject
public PipelineInterpreter(MessageQueueAcknowledger messageQueueAcknowledger,
                                   com.codahale.metrics.MetricRegistry metricRegistry,
                                   ConfigurationStateUpdater stateUpdater)

Method Detail

process

public Messages process(Messages messages)

Specified by:

process in interface MessageProcessor

Parameters:

messages - messages to process

Returns:

messages to pass on to the next stage

process

public Messages process(Messages messages,
                        InterpreterListener interpreterListener,
                        PipelineInterpreter.State state)

Evaluates all pipelines that apply to the given messages, based on the current stream routing of the messages. The processing loops on each single message (passed in or created by pipelines) until the set of streams does not change anymore. No cycle detection is performed.

Parameters:

messages - the messages to process through the pipelines

interpreterListener - a listener which gets called for each processing stage (e.g. to trace execution)

state - the pipeline/stage/rule/stream connection state to use during processing

Returns:

the processed messages

processForPipelines

public List<Message> processForPipelines(Message message,
                                         Set<String> pipelineIds,
                                         InterpreterListener interpreterListener,
                                         PipelineInterpreter.State state)

Given a set of pipeline ids, process the given message according to the passed state. This method returns the list of messages produced by the configuration in state, it does not look at the database or any other external resource besides what is being passed as parameters. This can be used to simulate pipelines without having to store them in the database.

Parameters:

message - the message to process

pipelineIds - the ids of the pipelines to resolve and run the message through

interpreterListener - the listener tracing the execution

state - the pipeline/stage/rule state to interpret

Returns:

the list of messages created during the interpreter run