org.graylog.plugins.pipelineprocessor.ast

Class Rule

java.lang.Object

org.graylog.plugins.pipelineprocessor.ast.Rule

public abstract class Rule
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.Builder

Constructor Summary

Constructors

Constructor and Description
Rule()

Method Summary

Modifier and Type	Method and Description
static Rule	alwaysFalse(String name)
static Rule.Builder	builder()
abstract GeneratedRule	generatedRule()
abstract Class<? extends GeneratedRule>	generatedRuleClass()
abstract String	id()
Rule	invokableCopy(FunctionRegistry functionRegistry) Creates a copy of this Rule with a new instance of the generated rule class if present.
void	markExecution()
void	markFailure()
void	markMatch()
void	markNonMatch()
com.codahale.metrics.MetricFilter	metricsFilter() The metric filter matching all metrics that have been registered by this pipeline.
abstract String	name()
void	registerMetrics(com.codahale.metrics.MetricRegistry metricRegistry, String pipelineId, String stageId) Register the metrics attached to this pipeline.
abstract Collection<Statement>	then()
abstract Rule.Builder	toBuilder()
String	toString()
abstract LogicalExpression	when()
Rule	withId(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule()

Method Detail

id

@Nullable
public abstract String id()

name

public abstract String name()

when

public abstract LogicalExpression when()

then

public abstract Collection<Statement> then()

generatedRuleClass

@Nullable
public abstract Class<? extends GeneratedRule> generatedRuleClass()

generatedRule

@Nullable
public abstract GeneratedRule generatedRule()

builder

public static Rule.Builder builder()

toBuilder

public abstract Rule.Builder toBuilder()

withId

public Rule withId(String id)

alwaysFalse

public static Rule alwaysFalse(String name)

registerMetrics

public void registerMetrics(com.codahale.metrics.MetricRegistry metricRegistry,
                            String pipelineId,
                            String stageId)

Register the metrics attached to this pipeline.

Parameters:

metricRegistry - the registry to add the metrics to

metricsFilter

public com.codahale.metrics.MetricFilter metricsFilter()

The metric filter matching all metrics that have been registered by this pipeline. Commonly used to remove the relevant metrics from the registry upon deletion of the pipeline.

Returns:

the filter matching this pipeline's metrics

markExecution

public void markExecution()

markMatch

public void markMatch()

markNonMatch

public void markNonMatch()

markFailure

public void markFailure()

invokableCopy

public Rule invokableCopy(FunctionRegistry functionRegistry)

Creates a copy of this Rule with a new instance of the generated rule class if present. This prevents sharing instances across threads, which is not supported for performance reasons. Otherwise the generated code would need to be thread safe, adding to the runtime overhead. Instead we buy speed by spending more memory.

Parameters:

functionRegistry - the registered functions of the system

Returns:

a copy of this rule with a new instance of its generated code

toString

public String toString()

Overrides:

toString in class Object