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.processor.util.listen.AbstractListenEventProcessor<E>

org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor<BeatsEvent>

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 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 AbstractListenEventBatchingProcessor<BeatsEvent>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenBeats.beatsAttributes

Nested classes/interfaces inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

AbstractListenEventBatchingProcessor.FlowFileEventBatch

Field Summary

Fields

Modifier and Type	Field and Description
private BeatsEncoder	beatsEncoder
static PropertyDescriptor	CLIENT_AUTH
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Fields inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

messageDemarcatorBytes

Fields inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventProcessor

charset, CHARSET, descriptors, dispatcher, errorEvents, events, MAX_CONNECTIONS, MAX_MESSAGE_QUEUE_SIZE, MAX_SOCKET_BUFFER_SIZE, POLL_TIMEOUT_MS, port, PORT, RECV_BUFFER_SIZE, REL_SUCCESS, relationships

Constructor Summary

Constructors

Constructor and Description
ListenBeats()

Method Summary

Modifier and Type	Method and Description
protected ChannelDispatcher	createDispatcher(ProcessContext context, BlockingQueue<BeatsEvent> events)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected List<PropertyDescriptor>	getAdditionalProperties()
protected Map<String,String>	getAttributes(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)
protected String	getBatchKey(BeatsEvent event)
protected String	getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)
void	onScheduled(ProcessContext context)
protected void	postProcess(ProcessContext context, ProcessSession session, List<BeatsEvent> events)
protected void	respond(BeatsEvent event, BeatsResponse beatsResponse)

Methods inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventBatchingProcessor

getBatches, init, onTrigger

Methods inherited from class org.apache.nifi.processor.util.listen.AbstractListenEventProcessor

closeDispatcher, getAdditionalRelationships, getDispatcherPort, getErrorQueueSize, getLongPollTimeout, getMessage, getQueueSize, getRelationships, getSupportedPropertyDescriptors

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.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

beatsEncoder

private volatile BeatsEncoder beatsEncoder

Constructor Detail

ListenBeats

public ListenBeats()

Method Detail

getAdditionalProperties

protected List<PropertyDescriptor> getAdditionalProperties()

Overrides:

getAdditionalProperties in class AbstractListenEventProcessor<BeatsEvent>

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Overrides:

onScheduled in class AbstractListenEventBatchingProcessor<BeatsEvent>

Throws:

IOException

createDispatcher

protected ChannelDispatcher createDispatcher(ProcessContext context,
                                             BlockingQueue<BeatsEvent> events)
                                      throws IOException

Specified by:

createDispatcher in class AbstractListenEventProcessor<BeatsEvent>

Throws:

IOException

getBatchKey

protected String getBatchKey(BeatsEvent event)

Overrides:

getBatchKey in class AbstractListenEventBatchingProcessor<BeatsEvent>

respond

protected void respond(BeatsEvent event,
                       BeatsResponse beatsResponse)

postProcess

protected void postProcess(ProcessContext context,
                           ProcessSession session,
                           List<BeatsEvent> events)

Overrides:

postProcess in class AbstractListenEventBatchingProcessor<BeatsEvent>

getTransitUri

protected String getTransitUri(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)

Specified by:

getTransitUri in class AbstractListenEventBatchingProcessor<BeatsEvent>

getAttributes

protected Map<String,String> getAttributes(AbstractListenEventBatchingProcessor.FlowFileEventBatch batch)

Specified by:

getAttributes in class AbstractListenEventBatchingProcessor<BeatsEvent>