AbstractLogstashTcpSocketAppender (Logstash Logback Encoder 7.0.1 API)

java.lang.Object
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.UnsynchronizedAppenderBase<Event>
  - - net.logstash.logback.appender.AsyncDisruptorAppender<Event,Listener>
    - - net.logstash.logback.appender.AbstractLogstashTcpSocketAppender<Event,Listener>

All Implemented Interfaces:

Appender<Event>, ContextAware, FilterAttachable<Event>, LifeCycle

Direct Known Subclasses:

LogstashAccessTcpSocketAppender, LogstashTcpSocketAppender
```
public abstract class AbstractLogstashTcpSocketAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
extends AsyncDisruptorAppender<Event,Listener>
```
An AsyncDisruptorAppender appender that writes events to a TCP Socket outputStream.
The behavior is similar to a 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.LogEventFactory<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` Deprecated. Use `AsyncDisruptorAppender.DEFAULT_RING_BUFFER_SIZE` instead
`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`
`static int`	`DEFAULT_WRITE_TIMEOUT` The default write timeout in milliseconds (0 means no write timeout).
`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, listeners, 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()

Constructors
Constructor and Description
`AbstractLogstashTcpSocketAppender()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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.
`protected com.lmax.disruptor.EventHandler<AsyncDisruptorAppender.LogEvent<Event>>`	`createEventHandler()` Create the `EventHandler` to process events as they become available from the RingBuffer.
`protected void`	`fireConnectionClosed(Socket socket)`
`protected void`	`fireConnectionFailed(InetSocketAddress address, Throwable throwable)`
`protected void`	`fireConnectionOpened(Socket socket)`
`protected void`	`fireEventSendFailure(Event event, Throwable reason)`
`protected void`	`fireEventSent(Socket socket, Event event, long durationInNanos)`
`Optional<InetSocketAddress>`	`getConnectedDestination()` Returns the currently connected destination as an `Optional`.
`DestinationConnectionStrategy`	`getConnectionStrategy()`
`Duration`	`getConnectionTimeout()` Get the connection timeout used when establishing a TCP connection to a remote destination.
`List<InetSocketAddress>`	`getDestinations()` Return the destinations in which to attempt to send logs.
`Encoder<Event>`	`getEncoder()`
`protected String`	`getHostString(InetSocketAddress destination)` Returns the host string from the given destination, avoiding a DNS hit if possible.
`Charset`	`getKeepAliveCharset()`
`Duration`	`getKeepAliveDuration()`
`String`	`getKeepAliveMessage()`
`int`	`getQueueSize()` Deprecated. use `AsyncDisruptorAppender.getRingBufferSize()` instead.
`Duration`	`getReconnectionDelay()`
`Duration`	`getSecondaryConnectionTTL()` Deprecated. use `PreferPrimaryDestinationConnectionStrategy.getSecondaryConnectionTTL()` instead.
`SocketFactory`	`getSocketFactory()`
`SSLConfiguration`	`getSsl()`
`protected List<Object>`	`getThreadNameFormatParams()`
`int`	`getWriteBufferSize()`
`Duration`	`getWriteTimeout()`
`boolean`	`isKeepAliveEnabled()`
`boolean`	`isStarted()`
`boolean`	`isWriteTimeoutEnabled()` Whether the write timeout feature is enabled or not.
`protected Future<?>`	`scheduleReaderCallable(Callable<Void> readerCallable)`
`void`	`setConnectionStrategy(DestinationConnectionStrategy destinationConnectionStrategy)`
`void`	`setConnectionTimeout(Duration connectionTimeout)` Set the connection timeout when establishing a connection to a remote destination.
`void`	`setEncoder(Encoder<Event> encoder)`
`void`	`setKeepAliveCharset(Charset keepAliveCharset)` The charset to use when writing the `keepAliveMessage`.
`void`	`setKeepAliveDuration(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 and strictly positive.
`void`	`setQueueSize(int queueSize)` Deprecated. use `AsyncDisruptorAppender.setRingBufferSize(int)` instead.
`void`	`setReconnectionDelay(Duration delay)` Time period for which to wait after failing to connect to all servers, before attempting to reconnect.
`void`	`setSecondaryConnectionTTL(Duration secondaryConnectionTTL)` Deprecated. use `PreferPrimaryDestinationConnectionStrategy.setSecondaryConnectionTTL(Duration)` instead.
`void`	`setSocketFactory(SocketFactory socketFactory)` Set the `SocketFactory` used to create client `Socket`s to which to communicate.
`void`	`setSsl(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`	`setWriteTimeout(Duration writeTimeout)` Sets the time period for which to wait for a write to complete before timing out and attempting to reconnect to that destination.
`void`	`start()`
`void`	`stop()`
`protected void`	`updateCurrentThreadName()`

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_WRITE_TIMEOUT
```
public static final int DEFAULT_WRITE_TIMEOUT
```
    The default write timeout in milliseconds (0 means no write timeout).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_QUEUE_SIZE
```
@Deprecated
public static final int DEFAULT_QUEUE_SIZE
```
    Deprecated. Use AsyncDisruptorAppender.DEFAULT_RING_BUFFER_SIZE instead
    
    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. The same timeout is used as a read timeout during SSL handshake.
    
    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
  - createEventHandler
```
protected com.lmax.disruptor.EventHandler<AsyncDisruptorAppender.LogEvent<Event>> createEventHandler()
```
    Description copied from class: AsyncDisruptorAppender
    
    Create the EventHandler to process events as they become available from the RingBuffer. This method is invoked when the appender is started by AsyncDisruptorAppender.start() and a new Disruptor is initialized.
    
    Specified by:
    
    createEventHandler in class AsyncDisruptorAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
    
    Returns:
    
    a EventHandler instance.
  - isStarted
```
public boolean isStarted()
```
    Specified by:
    
    isStarted in interface LifeCycle
    
    Overrides:
    
    isStarted in class UnsynchronizedAppenderBase<Event extends DeferredProcessingAware>
  - start
```
public void start()
```
    Specified by:
    
    start in interface LifeCycle
    
    Overrides:
    
    start in class AsyncDisruptorAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface LifeCycle
    
    Overrides:
    
    stop in class AsyncDisruptorAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
  - scheduleReaderCallable
```
protected Future<?> scheduleReaderCallable(Callable<Void> readerCallable)
```
  - fireEventSent
```
protected void fireEventSent(Socket socket,
                             Event event,
                             long durationInNanos)
```
  - fireEventSendFailure
```
protected void fireEventSendFailure(Event event,
                                    Throwable reason)
```
  - fireConnectionOpened
```
protected void fireConnectionOpened(Socket socket)
```
  - fireConnectionClosed
```
protected void fireConnectionClosed(Socket socket)
```
  - fireConnectionFailed
```
protected void fireConnectionFailed(InetSocketAddress address,
                                    Throwable throwable)
```
  - getEncoder
```
public Encoder<Event> getEncoder()
```
  - setEncoder
```
public void setEncoder(Encoder<Event> encoder)
```
  - getSocketFactory
```
public SocketFactory getSocketFactory()
```
  - setSocketFactory
```
public void setSocketFactory(SocketFactory socketFactory)
```
    Set the SocketFactory used to create client Sockets to which to communicate. Use null to use the system default SocketFactory.
    
    Parameters:
    
    socketFactory - the socket factory to use to create connections with remote destinations.
  - 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 default (4560) will be used
    For example, "host1.domain.com,host2.domain.com:5560"
    
    Parameters:
    
    destination - comma-separated list of destinations in the form of hostName[:portNumber]
    
    Throws:
    
    IllegalArgumentException
  - addDestinations
```
public void addDestinations(InetSocketAddress... destinations)
                     throws IllegalArgumentException
```
    Adds the given destinations to the list of potential destinations.
    
    Parameters:
    
    destinations - the InetSocketAddress to add to the list of valid destinations
    
    Throws:
    
    IllegalArgumentException
  - getHostString
```
protected String getHostString(InetSocketAddress destination)
```
    Returns the host string from the given destination, avoiding a DNS hit if possible.
    
    Parameters:
    
    destination - the InetSocketAddress to get the host string from
    
    Returns:
    
    the host string of the given destination
  - updateCurrentThreadName
```
protected void updateCurrentThreadName()
```
  - getThreadNameFormatParams
```
protected List<Object> getThreadNameFormatParams()
```
    Overrides:
    
    getThreadNameFormatParams in class AsyncDisruptorAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
  - getDestinations
```
public List<InetSocketAddress> getDestinations()
```
    Return the destinations in which to attempt to send logs.
    
    Returns:
    
    an ordered list of InetSocketAddress representing the configured destinations
  - setReconnectionDelay
```
public void setReconnectionDelay(Duration delay)
```
    Time period for which to wait after failing to connect to all servers, before attempting to reconnect. Default is 30000 milliseconds.
    
    Parameters:
    
    delay - the reconnection delay
  - getReconnectionDelay
```
public Duration getReconnectionDelay()
```
  - setSecondaryConnectionTTL
```
@Deprecated
public void setSecondaryConnectionTTL(Duration secondaryConnectionTTL)
```
    Deprecated. use PreferPrimaryDestinationConnectionStrategy.setSecondaryConnectionTTL(Duration) instead.
    
    Convenience method for setting PreferPrimaryDestinationConnectionStrategy.setSecondaryConnectionTTL(Duration). When the connectionStrategy is a PreferPrimaryDestinationConnectionStrategy, this will set its PreferPrimaryDestinationConnectionStrategy.setSecondaryConnectionTTL(Duration).
    
    Parameters:
    
    secondaryConnectionTTL - the TTL of a connection when connected to a secondary destination
    
    Throws:
    
    IllegalStateException - if the connectionStrategy is not a PreferPrimaryDestinationConnectionStrategy
    
    See Also:
    
    PreferPrimaryDestinationConnectionStrategy.setSecondaryConnectionTTL(Duration)
  - getSecondaryConnectionTTL
```
@Deprecated
public Duration getSecondaryConnectionTTL()
```
    Deprecated. use PreferPrimaryDestinationConnectionStrategy.getSecondaryConnectionTTL() instead.
    
    Convenience method for accessing PreferPrimaryDestinationConnectionStrategy.getSecondaryConnectionTTL().
    
    Returns:
    
    the secondary connection TTL or null if the connection strategy is not a PreferPrimaryDestinationConnectionStrategy.
    
    See Also:
    
    getConnectionStrategy(), PreferPrimaryDestinationConnectionStrategy.getSecondaryConnectionTTL()
  - setConnectionTimeout
```
public void setConnectionTimeout(Duration connectionTimeout)
```
    Set the connection timeout when establishing a connection to a remote destination. Use 0 for an "infinite timeout" which often really means "use the OS defaults".
    
    Parameters:
    
    connectionTimeout - connection timeout
  - getConnectionTimeout
```
public Duration getConnectionTimeout()
```
    Get the connection timeout used when establishing a TCP connection to a remote destination.
    
    Returns:
    
    the connection timeout (never null).
  - getWriteBufferSize
```
public int getWriteBufferSize()
```
  - setWriteBufferSize
```
public void setWriteBufferSize(int writeBufferSize)
```
    The number of bytes available in the write buffer. Defaults to 8192.
    If less than or equal to zero, buffering the output stream will be disabled. If buffering is disabled, the writer thread can slow down, but it will also can prevent dropping events in the buffer on flaky connections.
    
    Parameters:
    
    writeBufferSize - the write buffer size in bytes
  - getQueueSize
```
@Deprecated
public int getQueueSize()
```
    Deprecated. use AsyncDisruptorAppender.getRingBufferSize() instead.
    
    Returns the maximum number of events in the queue. Alias for AsyncDisruptorAppender.getRingBufferSize().
    
    Returns:
    
    the size of the ring buffer
  - setQueueSize
```
@Deprecated
public void setQueueSize(int queueSize)
```
    Deprecated. use AsyncDisruptorAppender.setRingBufferSize(int) instead.
    
    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 SSLConfiguration getSsl()
```
  - setSsl
```
public void setSsl(SSLConfiguration sslConfiguration)
```
    Set this to non-null to use SSL. See the logback manual for details on how to configure SSL for a client.
    
    Parameters:
    
    sslConfiguration - the SSL configuration
  - getKeepAliveDuration
```
public Duration getKeepAliveDuration()
```
  - setKeepAliveDuration
```
public void setKeepAliveDuration(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, zero or negative, no keepAlive messages will be sent.
    
    Parameters:
    
    keepAliveDuration - duration between consecutive keep alive messages
  - getKeepAliveMessage
```
public String getKeepAliveMessage()
```
  - setKeepAliveMessage
```
public void setKeepAliveMessage(String keepAliveMessage)
```
    Message to send for keeping the connection alive if keepAliveDuration is non-null and strictly positive. 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.
    Parameters:
    
    keepAliveMessage - the keep alive message
  - isKeepAliveEnabled
```
public boolean isKeepAliveEnabled()
```
  - isWriteTimeoutEnabled
```
public boolean isWriteTimeoutEnabled()
```
    Whether the write timeout feature is enabled or not.
    
    Returns:
    
    true when the appender should try to detect write timeouts, false otherwise.
  - getKeepAliveCharset
```
public Charset getKeepAliveCharset()
```
  - setKeepAliveCharset
```
public void setKeepAliveCharset(Charset keepAliveCharset)
```
    The charset to use when writing the keepAliveMessage. Defaults to UTF-8.
    
    Parameters:
    
    keepAliveCharset - charset encoding for the keep alive message
  - 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 DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>
    
    Parameters:
    
    threadNameFormat - thread name format pattern
  - getConnectionStrategy
```
public DestinationConnectionStrategy getConnectionStrategy()
```
  - setConnectionStrategy
```
public void setConnectionStrategy(DestinationConnectionStrategy destinationConnectionStrategy)
```
  - getConnectedDestination
```
public Optional<InetSocketAddress> getConnectedDestination()
```
    Returns the currently connected destination as an Optional. The Optional will be absent if the appender is not currently connected.
    
    Returns:
    
    the currently connected destination as an Optional. The Optional will be absent if the appender is not currently connected.
  - getWriteTimeout
```
public Duration getWriteTimeout()
```
  - setWriteTimeout
```
public void setWriteTimeout(Duration writeTimeout)
```
    Sets the time period for which to wait for a write to complete before timing out and attempting to reconnect to that destination. This timeout is used to detect connections where the receiver stops reading.
    The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout which effectively means "no write timeout".
    Note that since a blocking java socket output stream does not have a concept of a write timeout, a task will be scheduled with the same frequency as the write timeout in order to detect stuck writes. It is recommended to use longer write timeouts (e.g. > 30s, or minutes), rather than short write timeouts, so that this task does not execute too frequently. Also, this approach means that it could take up to two times the write timeout before a write timeout is detected.
    
    Parameters:
    
    writeTimeout - the write timeout

Class AbstractLogstashTcpSocketAppender<Event extends DeferredProcessingAware,Listener extends TcpAppenderListener<Event>>

Nested Class Summary

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

HOST_NAME_FORMAT

PORT_FORMAT

DEFAULT_THREAD_NAME_FORMAT

DEFAULT_PORT

DEFAULT_RECONNECTION_DELAY

DEFAULT_WRITE_TIMEOUT

DEFAULT_QUEUE_SIZE

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_WRITE_BUFFER_SIZE

Constructor Detail

AbstractLogstashTcpSocketAppender

Method Detail

createEventHandler

isStarted

start

stop

scheduleReaderCallable

fireEventSent

fireEventSendFailure

fireConnectionOpened

fireConnectionClosed

fireConnectionFailed

getEncoder

setEncoder

getSocketFactory

setSocketFactory

addDestination

addDestinations

getHostString

updateCurrentThreadName

getThreadNameFormatParams

getDestinations

setReconnectionDelay

getReconnectionDelay

setSecondaryConnectionTTL

getSecondaryConnectionTTL

setConnectionTimeout

getConnectionTimeout

getWriteBufferSize

setWriteBufferSize

getQueueSize

setQueueSize

getSsl

setSsl

getKeepAliveDuration

setKeepAliveDuration

getKeepAliveMessage

setKeepAliveMessage

isKeepAliveEnabled

isWriteTimeoutEnabled

getKeepAliveCharset

setKeepAliveCharset

setThreadNameFormat

getConnectionStrategy

setConnectionStrategy

getConnectedDestination

getWriteTimeout

setWriteTimeout