net.logstash.logback.appender

Class AbstractLogstashTcpSocketAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<Event>

net.logstash.logback.appender.AsyncDisruptorAppender<Event>

net.logstash.logback.appender.AbstractLogstashTcpSocketAppender<Event>

All Implemented Interfaces:

ch.qos.logback.core.Appender<Event>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<Event>, ch.qos.logback.core.spi.LifeCycle

Direct Known Subclasses:

LogstashAccessTcpSocketAppender, LogstashTcpSocketAppender

public abstract class AbstractLogstashTcpSocketAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends AsyncDisruptorAppender<Event>

An AsyncDisruptorAppender appender that writes events to a TCP Socket outputStream.

The behavior is similar to a ch.qos.logback.classic.net.SocketAppender, except that:

• it uses a RingBuffer instead of a BlockingQueue
• it writes using an Encoder instead of serialization

In addition, SSL can be enabled by setting the SSL configuration via setSsl(SSLConfiguration). See the logback manual for details on how to configure client-side SSL.

Since:

11 Jun 2014 (creation date)

Author:

Mirko Bernardoni (original, which did not use disruptor)

Nested Class Summary

Nested classes/interfaces inherited from class net.logstash.logback.appender.AsyncDisruptorAppender

AsyncDisruptorAppender.LogEvent<Event>, AsyncDisruptorAppender.LogEventTranslator<Event>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT Default timeout when waiting for the remote server to accept our connection.
static int	DEFAULT_PORT The default port number of remote logging server (4560).
static int	DEFAULT_QUEUE_SIZE Default size of the queue used to hold logging events that are destined for the remote peer.
static int	DEFAULT_RECONNECTION_DELAY The default reconnection delay (30000 milliseconds or 30 seconds).
static String	DEFAULT_THREAD_NAME_FORMAT
static int	DEFAULT_WRITE_BUFFER_SIZE
protected static String	HOST_NAME_FORMAT
protected static String	PORT_FORMAT

Fields inherited from class net.logstash.logback.appender.AsyncDisruptorAppender

APPENDER_NAME_FORMAT, DEFAULT_DROPPED_WARN_FREQUENCY, DEFAULT_PRODUCER_TYPE, DEFAULT_RING_BUFFER_SIZE, DEFAULT_WAIT_STRATEGY, THREAD_INDEX_FORMAT

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
AbstractLogstashTcpSocketAppender()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDestination(String destination) Adds the given destination (or destinations) to the list of potential destinations to which to send logs.
void	addDestinations(InetSocketAddress... destinations) Adds the given destinations to the list of potential destinations.
List<InetSocketAddress>	getDestinations() Return the destinations in which to attempt to send logs.
ch.qos.logback.core.encoder.Encoder<Event>	getEncoder()
protected String	getHostString(InetSocketAddress destination) Returns the host string from the given destination, avoiding a DNS hit if possible.
Charset	getKeepAliveCharset()
ch.qos.logback.core.util.Duration	getKeepAliveDuration()
String	getKeepAliveMessage()
int	getPort() Deprecated.
int	getQueueSize() Returns the maximum number of events in the queue.
ch.qos.logback.core.util.Duration	getReconnectionDelay()
String	getRemoteHost() Deprecated.
ch.qos.logback.core.util.Duration	getSecondaryConnectionTTL()
SocketFactory	getSocketFactory()
ch.qos.logback.core.net.ssl.SSLConfiguration	getSsl()
protected List<Object>	getThreadNameFormatParams()
int	getWriteBufferSize()
boolean	isKeepAliveEnabled()
boolean	isStarted()
protected Future<?>	scheduleReaderRunnable(Runnable readerRunnable)
void	setEncoder(ch.qos.logback.core.encoder.Encoder<Event> encoder)
void	setKeepAliveCharset(Charset keepAliveCharset) The charset to use when writing the keepAliveMessage.
void	setKeepAliveDuration(ch.qos.logback.core.util.Duration keepAliveDuration) If this duration elapses without an event being sent, then the keepAliveMessage will be sent to the socket in order to keep the connection alive.
void	setKeepAliveMessage(String keepAliveMessage) Message to send for keeping the connection alive if keepAliveDuration is non-null.
void	setPort(int port) Deprecated. use addDestination(String) instead
void	setQueueSize(int queueSize) Sets the maximum number of events in the queue.
void	setReconnectionDelay(ch.qos.logback.core.util.Duration delay) Time period for which to wait after failing to connect to all servers, before attempting to reconnect.
void	setRemoteHost(String host) Deprecated. use addDestination(String) instead
void	setSecondaryConnectionTTL(ch.qos.logback.core.util.Duration secondaryConnectionTTL) Time period for connections to secondary destinations to be used before attempting to reconnect to primary server.
void	setSocketFactory(SocketFactory socketFactory) Used to create client Sockets to which to communicate.
void	setSsl(ch.qos.logback.core.net.ssl.SSLConfiguration sslConfiguration) Set this to non-null to use SSL.
void	setThreadNameFormat(String threadNameFormat) Pattern used by the to set the handler thread name.
void	setWriteBufferSize(int writeBufferSize) The number of bytes available in the write buffer.
void	start()
void	stop()
protected void	updateCurrentThreadName()

Methods inherited from class net.logstash.logback.appender.AsyncDisruptorAppender

append, calculateThreadName, getDisruptor, getDroppedWarnFrequency, getEventHandler, getEventTranslator, getExecutorService, getProducerType, getRingBufferSize, getThreadFactory, getThreadNameFormat, getThreadNamePrefix, getThreadPoolCoreSize, getWaitStrategy, isDaemon, prepareForDeferredProcessing, setDaemon, setDroppedWarnFrequency, setEventFactory, setEventHandler, setEventTranslator, setProducerType, setRingBufferSize, setThreadFactory, setThreadNamePrefix, setThreadPoolCoreSize, setWaitStrategy, setWaitStrategyType

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

HOST_NAME_FORMAT

protected static final String HOST_NAME_FORMAT

See Also:

Constant Field Values

PORT_FORMAT

protected static final String PORT_FORMAT

See Also:

Constant Field Values

DEFAULT_THREAD_NAME_FORMAT

public static final String DEFAULT_THREAD_NAME_FORMAT

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port number of remote logging server (4560).

See Also:

Constant Field Values

DEFAULT_RECONNECTION_DELAY

public static final int DEFAULT_RECONNECTION_DELAY

The default reconnection delay (30000 milliseconds or 30 seconds).

See Also:

Constant Field Values

DEFAULT_QUEUE_SIZE

public static final int DEFAULT_QUEUE_SIZE

Default size of the queue used to hold logging events that are destined for the remote peer. Assuming an average log entry to take 1k, this would result in the application using about 10MB additional memory if the queue is full

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

Default timeout when waiting for the remote server to accept our connection.

See Also:

Constant Field Values

DEFAULT_WRITE_BUFFER_SIZE

public static final int DEFAULT_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractLogstashTcpSocketAppender

public AbstractLogstashTcpSocketAppender()

Method Detail

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

isStarted in class ch.qos.logback.core.UnsynchronizedAppenderBase<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class AsyncDisruptorAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class AsyncDisruptorAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

scheduleReaderRunnable

protected Future<?> scheduleReaderRunnable(Runnable readerRunnable)

getEncoder

public ch.qos.logback.core.encoder.Encoder<Event> getEncoder()

setEncoder

public void setEncoder(ch.qos.logback.core.encoder.Encoder<Event> encoder)

getSocketFactory

public SocketFactory getSocketFactory()

setSocketFactory

public void setSocketFactory(SocketFactory socketFactory)

Used to create client Sockets to which to communicate. By default, it is the system default SocketFactory.

setRemoteHost

@Deprecated
public void setRemoteHost(String host)

Deprecated. use addDestination(String) instead

The host to which to connect and send events

getRemoteHost

@Deprecated
public String getRemoteHost()

Deprecated.

setPort

@Deprecated
public void setPort(int port)

Deprecated. use addDestination(String) instead

The TCP port on the host to which to connect and send events

getPort

@Deprecated
public int getPort()

Deprecated.

addDestination

public void addDestination(String destination)
                    throws IllegalArgumentException

Adds the given destination (or destinations) to the list of potential destinations to which to send logs.

The string is a comma separated list of destinations in the form of hostName[:portNumber].

If portNumber is not provided, then the configured port will be used, which defaults to 4560

For example, "host1.domain.com,host2.domain.com:5560"

Throws:

IllegalArgumentException

addDestinations

public void addDestinations(InetSocketAddress... destinations)
                     throws IllegalArgumentException

Adds the given destinations to the list of potential destinations.

Throws:

IllegalArgumentException

getHostString

@IgnoreJRERequirement
protected String getHostString(InetSocketAddress destination)

Returns the host string from the given destination, avoiding a DNS hit if possible.

updateCurrentThreadName

protected void updateCurrentThreadName()

getThreadNameFormatParams

protected List<Object> getThreadNameFormatParams()

Overrides:

getThreadNameFormatParams in class AsyncDisruptorAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

getDestinations

public List<InetSocketAddress> getDestinations()

Return the destinations in which to attempt to send logs.

setReconnectionDelay

public void setReconnectionDelay(ch.qos.logback.core.util.Duration delay)

Time period for which to wait after failing to connect to all servers, before attempting to reconnect. Default is 30000 milliseconds.

getReconnectionDelay

public ch.qos.logback.core.util.Duration getReconnectionDelay()

setSecondaryConnectionTTL

public void setSecondaryConnectionTTL(ch.qos.logback.core.util.Duration secondaryConnectionTTL)

Time period for connections to secondary destinations to be used before attempting to reconnect to primary server. When the value is null (the default), the feature is disabled: the appender will stay on the current destination until an error occurs.

getSecondaryConnectionTTL

public ch.qos.logback.core.util.Duration getSecondaryConnectionTTL()

getWriteBufferSize

public int getWriteBufferSize()

setWriteBufferSize

public void setWriteBufferSize(int writeBufferSize)

The number of bytes available in the write buffer.

getQueueSize

public int getQueueSize()

Returns the maximum number of events in the queue.

setQueueSize

public void setQueueSize(int queueSize)

Sets the maximum number of events in the queue. Once the queue is full additional events will be dropped.

Must be a positive power of 2.

Parameters:

queueSize - the maximum number of entries in the queue.

getSsl

public ch.qos.logback.core.net.ssl.SSLConfiguration getSsl()

setSsl

public void setSsl(ch.qos.logback.core.net.ssl.SSLConfiguration sslConfiguration)

Set this to non-null to use SSL. See the logback manual for details on how to configure SSL for a client.

getKeepAliveDuration

public ch.qos.logback.core.util.Duration getKeepAliveDuration()

setKeepAliveDuration

public void setKeepAliveDuration(ch.qos.logback.core.util.Duration keepAliveDuration)

If this duration elapses without an event being sent, then the keepAliveMessage will be sent to the socket in order to keep the connection alive. When null, no keepAlive messages will be sent.

getKeepAliveMessage

public String getKeepAliveMessage()

setKeepAliveMessage

public void setKeepAliveMessage(String keepAliveMessage)

Message to send for keeping the connection alive if keepAliveDuration is non-null. The following values have special meaning:

• null or empty string = no keep alive.
• "SYSTEM" = operating system new line (default).
• "UNIX" = unix line ending (\n).
• "WINDOWS" = windows line ending (\r\n).

Any other value will be used as-is.

isKeepAliveEnabled

public boolean isKeepAliveEnabled()

getKeepAliveCharset

public Charset getKeepAliveCharset()

setKeepAliveCharset

public void setKeepAliveCharset(Charset keepAliveCharset)

The charset to use when writing the keepAliveMessage. Defaults to UTF-8.

setThreadNameFormat

public void setThreadNameFormat(String threadNameFormat)

Pattern used by the to set the handler thread name. Defaults to "logback-appender-%1$s-%3$s:%4$d-%2$d".

If you change the AsyncDisruptorAppender.threadFactory, then this value may not be honored.

The string is a format pattern understood by Formatter.format(String, Object...). Formatter.format(String, Object...) is used to construct the actual thread name prefix. The first argument (%1$s) is the string appender name. The second argument (%2$d) is the numerical thread index. The third argument (%3$s) is the string hostname of the currently connected destination. The fourth argument (%4$d) is the numerical port of the currently connected destination. Other arguments can be made available by subclasses.

Overrides:

setThreadNameFormat in class AsyncDisruptorAppender<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>