org.apache.nifi.processors.standard

Class ExtractGrok

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ExtractGrok

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @SideEffectFree
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"grok","log","text","parse","delimit","extract"})
 @CapabilityDescription(value="Evaluates one or more Grok Expressions against the content of a FlowFile, adding the results as attributes or replacing the content of the FlowFile with a JSON notation of the matched content")
 @WritesAttributes(value=@WritesAttribute(attribute="grok.XXX",description="When operating in flowfile-attribute mode, each of the Grok identifier that is matched in the flowfile will be added as an attribute, prefixed with \"grok.\" For example,if the grok identifier \"timestamp\" is matched, then the value will be added to an attribute named \"grok.timestamp\""))
 @Restricted(restrictions=@Restriction(requiredPermission=REFERENCE_REMOTE_RESOURCES,explanation="Patterns can reference resources over HTTP"))
public class ExtractGrok
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private static String	APPLICATION_JSON
private BlockingQueue<byte[]>	bufferQueue
static PropertyDescriptor	CHARACTER_SET
private static String	DEFAULT_PATTERN_NAME
private static List<PropertyDescriptor>	descriptors
static PropertyDescriptor	DESTINATION
static String	FLOWFILE_ATTRIBUTE
static String	FLOWFILE_CONTENT
private io.krakens.grok.api.Grok	grok
static PropertyDescriptor	GROK_EXPRESSION
static PropertyDescriptor	GROK_PATTERNS
static PropertyDescriptor	KEEP_EMPTY_CAPTURES
private AtomicBoolean	keepEmptyCaputures
static PropertyDescriptor	MAX_BUFFER_SIZE
static PropertyDescriptor	NAMED_CAPTURES_ONLY
static Relationship	REL_MATCH
static Relationship	REL_NO_MATCH
private static Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
ExtractGrok()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onScheduled(ProcessContext context)
void	onStopped()
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

FLOWFILE_ATTRIBUTE

public static final String FLOWFILE_ATTRIBUTE

See Also:

Constant Field Values

FLOWFILE_CONTENT

public static final String FLOWFILE_CONTENT

See Also:

Constant Field Values

APPLICATION_JSON

private static final String APPLICATION_JSON

See Also:

Constant Field Values

DEFAULT_PATTERN_NAME

private static final String DEFAULT_PATTERN_NAME

See Also:

Constant Field Values

GROK_EXPRESSION

public static final PropertyDescriptor GROK_EXPRESSION

GROK_PATTERNS

public static final PropertyDescriptor GROK_PATTERNS

KEEP_EMPTY_CAPTURES

public static final PropertyDescriptor KEEP_EMPTY_CAPTURES

DESTINATION

public static final PropertyDescriptor DESTINATION

CHARACTER_SET

public static final PropertyDescriptor CHARACTER_SET

MAX_BUFFER_SIZE

public static final PropertyDescriptor MAX_BUFFER_SIZE

NAMED_CAPTURES_ONLY

public static final PropertyDescriptor NAMED_CAPTURES_ONLY

REL_MATCH

public static final Relationship REL_MATCH

REL_NO_MATCH

public static final Relationship REL_NO_MATCH

descriptors

private static final List<PropertyDescriptor> descriptors

relationships

private static final Set<Relationship> relationships

grok

private volatile io.krakens.grok.api.Grok grok

bufferQueue

private final BlockingQueue<byte[]> bufferQueue

keepEmptyCaputures

private final AtomicBoolean keepEmptyCaputures

Constructor Detail

ExtractGrok

public ExtractGrok()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onStopped

@OnStopped
public void onStopped()

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws io.krakens.grok.api.exception.GrokException,
                                     IOException

Throws:

io.krakens.grok.api.exception.GrokException

IOException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException