org.opennms.netmgt.syslogd

Class SyslogReceiverNioDisruptorImpl

java.lang.Object

org.opennms.netmgt.syslogd.SyslogReceiverNioDisruptorImpl

All Implemented Interfaces:

Runnable, SyslogReceiver

public class SyslogReceiverNioDisruptorImpl
extends Object
implements SyslogReceiver

This implementation of SyslogReceiver uses multithreaded NIO to handle socket receive() calls and then uses an LMAX disruptor ring buffer to store the packet data. The packets are then decoded using async CompletableFuture calls that are executed on a set of ExecutorService thread pools.

Author:

Seth

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_CONVERSION_TASK_QUEUE_SIZE This is the size of the LMAX Disruptor queue that contains SyslogConnection tasks that will convert the syslog bytes into OpenNMS events.
static int	EVENT_PARSER_THREADS This is the number of threads that are used to parse syslog messages into OpenNMS events.
static int	EVENT_SENDER_THREADS This is the number of threads that are used to broadcast the OpenNMS events.
static int	MAX_PACKET_SIZE This size is used as the size of each ByteBuffer used to capture syslog messages.
static int	SOCKET_BYTE_BUFFER_QUEUE_SIZE This is the size of the LMAX Disruptor queue that contains preallocated ByteBufferMessage instances.
static int	SOCKET_RECEIVER_THREADS This is the number of NIO listener threads that will process DatagramChannel.receive(ByteBuffer) calls on the syslog port.

Constructor Summary

Constructors

Constructor and Description
SyslogReceiverNioDisruptorImpl(SyslogdConfig config) Construct a new receiver

Method Summary

Modifier and Type	Method and Description
ExecutorFactory	getExecutorFactory()
String	getName()
static DatagramChannel	openChannel(SyslogdConfig config)
void	run() The execution context.
void	setExecutorFactory(ExecutorFactory executorFactory)
void	stop() stop the current receiver

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PACKET_SIZE

public static final int MAX_PACKET_SIZE

This size is used as the size of each ByteBuffer used to capture syslog messages. TODO: Make this configurable

See Also:

Constant Field Values

SOCKET_RECEIVER_THREADS

public static final int SOCKET_RECEIVER_THREADS

This is the number of NIO listener threads that will process DatagramChannel.receive(ByteBuffer) calls on the syslog port. TODO: Make this configurable

EVENT_PARSER_THREADS

public static final int EVENT_PARSER_THREADS

This is the number of threads that are used to parse syslog messages into OpenNMS events. TODO: Make this configurable

EVENT_SENDER_THREADS

public static final int EVENT_SENDER_THREADS

This is the number of threads that are used to broadcast the OpenNMS events. TODO: Make this configurable

SOCKET_BYTE_BUFFER_QUEUE_SIZE

public static final int SOCKET_BYTE_BUFFER_QUEUE_SIZE

This is the size of the LMAX Disruptor queue that contains preallocated ByteBufferMessage instances. This is the number of simultaneous messages that can be in-flight at any given time. TODO: Make this configurable

See Also:

Constant Field Values

EVENT_CONVERSION_TASK_QUEUE_SIZE

public static final int EVENT_CONVERSION_TASK_QUEUE_SIZE

This is the size of the LMAX Disruptor queue that contains SyslogConnection tasks that will convert the syslog bytes into OpenNMS events. TODO: Make this configurable

See Also:

Constant Field Values

Constructor Detail

SyslogReceiverNioDisruptorImpl

public SyslogReceiverNioDisruptorImpl(SyslogdConfig config)
                               throws SocketException,
                                      IOException

Construct a new receiver

Parameters:

sock -

matchPattern -

hostGroup -

messageGroup -

Throws:

SocketException

IOException

Method Detail

openChannel

public static DatagramChannel openChannel(SyslogdConfig config)
                                   throws SocketException,
                                          IOException

Throws:

SocketException

IOException

getName

public String getName()

Specified by:

getName in interface SyslogReceiver

getExecutorFactory

public ExecutorFactory getExecutorFactory()

setExecutorFactory

public void setExecutorFactory(ExecutorFactory executorFactory)

stop

public void stop()
          throws InterruptedException

stop the current receiver

Specified by:

stop in interface SyslogReceiver

Throws:

InterruptedException

run

public void run()

The execution context.

Specified by:

run in interface Runnable

Specified by:

run in interface SyslogReceiver