org.apache.nifi.processors.beats

Class ListenBeats

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.beats.ListenBeats

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"listen","beats","tcp","logs"})
 @CapabilityDescription(value="Listens for messages sent by libbeat compatible clients (e.g. filebeats, metricbeats, etc) using Libbeat\'s \'output.logstash\', writing its JSON formatted payload to the content of a FlowFile.This processor replaces the now deprecated/removed ListenLumberjack")
 @WritesAttribute(attribute="beats.sender",description="The sending host of the messages.") @WritesAttribute(attribute="beats.port",description="The sending port the messages were received over.") @WritesAttribute(attribute="beats.sequencenumber",description="The sequence number of the message. Only included if <Batch Size> is 1.") @WritesAttribute(attribute="mime.type",description="The mime.type of the content which is application/json")
 @SeeAlso(classNames="org.apache.nifi.processors.standard.ParseSyslog")
public class ListenBeats
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenBeats.beatsAttributes

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CLIENT_AUTH
protected List<PropertyDescriptor>	descriptors
protected BlockingQueue<BeatsMessage>	errorEvents
protected EventBatcher<BeatsMessage>	eventBatcher
protected BlockingQueue<BeatsMessage>	events
protected org.apache.nifi.event.transport.EventServer	eventServer
protected byte[]	messageDemarcatorBytes
protected int	port
static Relationship	REL_SUCCESS
protected Set<Relationship>	relationships
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Constructor Summary

Constructors

Constructor and Description
ListenBeats()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected Map<String,String>	getAttributes(FlowFileEventBatch<BeatsMessage> batch)
private EventBatcher<BeatsMessage>	getEventBatcher()
private String	getMessageDemarcator(ProcessContext context)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected String	getTransitUri(FlowFileEventBatch<BeatsMessage> batch)
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	processEvents(ProcessSession session, Map<String,FlowFileEventBatch<BeatsMessage>> batches)
void	stopped()

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

onTrigger

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

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, 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

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

REL_SUCCESS

public static final Relationship REL_SUCCESS

descriptors

protected List<PropertyDescriptor> descriptors

relationships

protected Set<Relationship> relationships

port

protected volatile int port

events

protected volatile BlockingQueue<BeatsMessage> events

errorEvents

protected volatile BlockingQueue<BeatsMessage> errorEvents

eventServer

protected volatile org.apache.nifi.event.transport.EventServer eventServer

messageDemarcatorBytes

protected volatile byte[] messageDemarcatorBytes

eventBatcher

protected volatile EventBatcher<BeatsMessage> eventBatcher

Constructor Detail

ListenBeats

public ListenBeats()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getRelationships

public final Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

stopped

@OnStopped
public void stopped()

processEvents

private void processEvents(ProcessSession session,
                           Map<String,FlowFileEventBatch<BeatsMessage>> batches)

getTransitUri

protected String getTransitUri(FlowFileEventBatch<BeatsMessage> batch)

getAttributes

protected Map<String,String> getAttributes(FlowFileEventBatch<BeatsMessage> batch)

getMessageDemarcator

private String getMessageDemarcator(ProcessContext context)

getEventBatcher

private EventBatcher<BeatsMessage> getEventBatcher()