org.apache.nifi.processors.standard

Class ListenSyslog

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractSyslogProcessor

org.apache.nifi.processors.standard.ListenSyslog

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"syslog","listen","udp","tcp","logs"})
 @CapabilityDescription(value="Listens for Syslog messages being sent to a given port over TCP or UDP. Incoming messages are checked against regular expressions for RFC5424 and RFC3164 formatted messages. The format of each message is: (<PRIORITY>)(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) where version is optional. The timestamp can be an RFC5424 timestamp with a format of \"yyyy-MM-dd\'T\'HH:mm:ss.SZ\" or \"yyyy-MM-dd\'T\'HH:mm:ss.S+hh:mm\", or it can be an RFC3164 timestamp with a format of \"MMM d HH:mm:ss\". If an incoming messages matches one of these patterns, the message will be parsed and the individual pieces will be placed in FlowFile attributes, with the original message in the content of the FlowFile. If an incoming message does not match one of these patterns it will not be parsed and the syslog.valid attribute will be set to false with the original message in the content of the FlowFile. Valid messages will be transferred on the success relationship, and invalid messages will be transferred on the invalid relationship.")
 @WritesAttribute(attribute="syslog.priority",description="The priority of the Syslog message.") @WritesAttribute(attribute="syslog.severity",description="The severity of the Syslog message derived from the priority.") @WritesAttribute(attribute="syslog.facility",description="The facility of the Syslog message derived from the priority.") @WritesAttribute(attribute="syslog.version",description="The optional version from the Syslog message.") @WritesAttribute(attribute="syslog.timestamp",description="The timestamp of the Syslog message.") @WritesAttribute(attribute="syslog.hostname",description="The hostname or IP address of the Syslog message.") @WritesAttribute(attribute="syslog.sender",description="The hostname of the Syslog server that sent the message.") @WritesAttribute(attribute="syslog.body",description="The body of the Syslog message, everything after the hostname.") @WritesAttribute(attribute="syslog.valid",description="An indicator of whether this message matched the expected formats. If this value is false, the other attributes will be empty and only the original message will be available in the content.") @WritesAttribute(attribute="syslog.protocol",description="The protocol over which the Syslog message was received.") @WritesAttribute(attribute="syslog.port",description="The port over which the Syslog message was received.") @WritesAttribute(attribute="mime.type",description="The mime.type of the FlowFile which will be text/plain for Syslog messages.")
 @SeeAlso(value={PutSyslog.class,ParseSyslog.class})
public class ListenSyslog
extends AbstractSyslogProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CLIENT_AUTH
private static String	DEFAULT_MIME_TYPE
private List<PropertyDescriptor>	descriptors
private EventServer	eventServer
static PropertyDescriptor	MAX_BATCH_SIZE
static PropertyDescriptor	MAX_CONNECTIONS
static PropertyDescriptor	MAX_MESSAGE_QUEUE_SIZE
static PropertyDescriptor	MAX_SOCKET_BUFFER_SIZE
static PropertyDescriptor	MESSAGE_DELIMITER
private byte[]	messageDemarcatorBytes
static PropertyDescriptor	PARSE_MESSAGES
private SyslogParser	parser
protected static String	RECEIVED_COUNTER
static PropertyDescriptor	RECV_BUFFER_SIZE
static Relationship	REL_INVALID
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SOCKET_KEEP_ALIVE
static PropertyDescriptor	SSL_CONTEXT_SERVICE
protected static String	SUCCESS_COUNTER
private BlockingQueue<ByteArrayMessage>	syslogEvents

Fields inherited from class org.apache.nifi.processors.standard.AbstractSyslogProcessor

CHARSET, PORT, PROTOCOL, TCP_VALUE, TIMEOUT, UDP_VALUE

Constructor Summary

Constructors

Constructor and Description
ListenSyslog()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private Map<String,String>	getDefaultAttributes(ProcessContext context)
private Map<String,String>	getEventAttributes(SyslogEvent event)
private InetAddress	getListenAddress(String networkInterfaceName)
int	getListeningPort()
private ByteArrayMessage	getMessage(ProcessSession session)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private String	getTransitUri(FlowFile flowFile)
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private SyslogEvent	parseSyslogEvent(ByteArrayMessage rawSyslogEvent)
void	shutdownEventServer()

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, 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, validate

Field Detail

MAX_MESSAGE_QUEUE_SIZE

public static final PropertyDescriptor MAX_MESSAGE_QUEUE_SIZE

RECV_BUFFER_SIZE

public static final PropertyDescriptor RECV_BUFFER_SIZE

MAX_SOCKET_BUFFER_SIZE

public static final PropertyDescriptor MAX_SOCKET_BUFFER_SIZE

MAX_CONNECTIONS

public static final PropertyDescriptor MAX_CONNECTIONS

MAX_BATCH_SIZE

public static final PropertyDescriptor MAX_BATCH_SIZE

MESSAGE_DELIMITER

public static final PropertyDescriptor MESSAGE_DELIMITER

PARSE_MESSAGES

public static final PropertyDescriptor PARSE_MESSAGES

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

SOCKET_KEEP_ALIVE

public static final PropertyDescriptor SOCKET_KEEP_ALIVE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_INVALID

public static final Relationship REL_INVALID

RECEIVED_COUNTER

protected static final String RECEIVED_COUNTER

See Also:

Constant Field Values

SUCCESS_COUNTER

protected static final String SUCCESS_COUNTER

See Also:

Constant Field Values

DEFAULT_MIME_TYPE

private static final String DEFAULT_MIME_TYPE

See Also:

Constant Field Values

relationships

private Set<Relationship> relationships

descriptors

private List<PropertyDescriptor> descriptors

eventServer

private volatile EventServer eventServer

parser

private volatile SyslogParser parser

syslogEvents

private volatile BlockingQueue<ByteArrayMessage> syslogEvents

messageDemarcatorBytes

private volatile byte[] messageDemarcatorBytes

Constructor Detail

ListenSyslog

public ListenSyslog()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

getListeningPort

public int getListeningPort()

shutdownEventServer

@OnStopped
public void shutdownEventServer()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getListenAddress

private InetAddress getListenAddress(String networkInterfaceName)
                              throws SocketException

Throws:

SocketException

parseSyslogEvent

private SyslogEvent parseSyslogEvent(ByteArrayMessage rawSyslogEvent)

getMessage

private ByteArrayMessage getMessage(ProcessSession session)

getTransitUri

private String getTransitUri(FlowFile flowFile)

getDefaultAttributes

private Map<String,String> getDefaultAttributes(ProcessContext context)

getEventAttributes

private Map<String,String> getEventAttributes(SyslogEvent event)