net.logstash.logback.appender

Class LogstashTcpSocketAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

net.logstash.logback.appender.LogstashTcpSocketAppender

All Implemented Interfaces:

ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.net.SocketConnector.ExceptionHandler, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle, java.lang.Runnable

public class LogstashTcpSocketAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>
implements java.lang.Runnable, ch.qos.logback.core.net.SocketConnector.ExceptionHandler

This class is a modification of SocketAppender. The queue type and the dispatch method is different than the original version.
The connection thread is going to be closed only if an event with the marker ClassicConstants.FINALIZE_SESSION_MARKER is sent.

For example:
logger.info(ClassicConstants.FINALIZE_SESSION_MARKER, "About to end the job");

Since:

11 Jun 2014 (creation date)

Author:

Mirko Bernardoni

Field Summary

Fields

Modifier and Type	Field and Description
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).
protected ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>	encoder It is the encoder which is ultimately responsible for writing the event to an OutputStream.

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

name, started

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

context

Constructor Summary

Constructors

Constructor and Description
LogstashTcpSocketAppender()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent event)
void	connectionFailed(ch.qos.logback.core.net.SocketConnector connector, java.lang.Exception ex)
protected void	encoderClose(java.io.OutputStream outputStream)
protected void	encoderInit(java.io.OutputStream outputStream)
ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>	getEncoder()
ch.qos.logback.core.util.Duration	getEventDelayLimit() Returns the value of the eventDelayLimit property.
int	getPort() Returns value of the Port property.
ch.qos.logback.core.spi.PreSerializationTransformer<ch.qos.logback.classic.spi.ILoggingEvent>	getPST() Get the pre-serialization transformer that will be used to transform each event into a Serializable object before delivery to the remote receiver.
ch.qos.logback.core.util.Duration	getReconnectionDelay() Returns value of the reconnectionDelay property.
java.lang.String	getRemoteHost() Returns value of the RemoteHost property.
protected javax.net.SocketFactory	getSocketFactory() Gets the default SocketFactory for the platform.
protected ch.qos.logback.core.net.SocketConnector	newConnector(java.net.InetAddress address, int port, long initialDelay, long retryDelay) Creates a new SocketConnector.
void	run()
void	setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder)
void	setEventDelayLimit(ch.qos.logback.core.util.Duration eventDelayLimit) The eventDelayLimit takes a non-negative integer representing the number of milliseconds to allow the appender to block if the underlying BlockingQueue is full.
void	setPort(int port) The Port property takes a positive integer representing the port where the server is waiting for connections.
void	setReconnectionDelay(ch.qos.logback.core.util.Duration delay) The reconnectionDelay property takes a positive Duration value representing the time to wait between each failed connection attempt to the server.
void	setRemoteHost(java.lang.String host) The RemoteHost property takes the name of of the host where a corresponding server is running.
void	start()
void	stop()

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

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, 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

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.

See Also:

Constant Field Values

encoder

protected ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder

It is the encoder which is ultimately responsible for writing the event to an OutputStream.

Constructor Detail

LogstashTcpSocketAppender

public LogstashTcpSocketAppender()

Method Detail

getEncoder

public ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> getEncoder()

Returns:

the encoder

setEncoder

public void setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder)

Parameters:

encoder - the encoder to set

getPST

public ch.qos.logback.core.spi.PreSerializationTransformer<ch.qos.logback.classic.spi.ILoggingEvent> getPST()

Get the pre-serialization transformer that will be used to transform each event into a Serializable object before delivery to the remote receiver.

Returns:

transformer object

encoderInit

protected void encoderInit(java.io.OutputStream outputStream)

encoderClose

protected void encoderClose(java.io.OutputStream outputStream)

start

public void start()

Specified by:

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

Overrides:

start in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

stop

public void stop()

Specified by:

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

Overrides:

stop in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent event)

Specified by:

append in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

run

public final void run()

Specified by:

run in interface java.lang.Runnable

connectionFailed

public void connectionFailed(ch.qos.logback.core.net.SocketConnector connector,
                    java.lang.Exception ex)

Specified by:

connectionFailed in interface ch.qos.logback.core.net.SocketConnector.ExceptionHandler

newConnector

protected ch.qos.logback.core.net.SocketConnector newConnector(java.net.InetAddress address,
                                                   int port,
                                                   long initialDelay,
                                                   long retryDelay)

Creates a new SocketConnector.

The default implementation creates an instance of DefaultSocketConnector. A subclass may override to provide a different SocketConnector implementation.

Parameters:

address - target remote address

port - target remote port

initialDelay - delay before the first connection attempt

retryDelay - delay before a reconnection attempt

Returns:

socket connector

getSocketFactory

protected javax.net.SocketFactory getSocketFactory()

Gets the default SocketFactory for the platform.

Subclasses may override to provide a custom socket factory.

setRemoteHost

public void setRemoteHost(java.lang.String host)

The RemoteHost property takes the name of of the host where a corresponding server is running.

getRemoteHost

public java.lang.String getRemoteHost()

Returns value of the RemoteHost property.

setPort

public void setPort(int port)

The Port property takes a positive integer representing the port where the server is waiting for connections.

getPort

public int getPort()

Returns value of the Port property.

setReconnectionDelay

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

The reconnectionDelay property takes a positive Duration value representing the time to wait between each failed connection attempt to the server. The default value of this option is to 30 seconds.

Setting this option to zero turns off reconnection capability.

getReconnectionDelay

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

Returns value of the reconnectionDelay property.

setEventDelayLimit

public void setEventDelayLimit(ch.qos.logback.core.util.Duration eventDelayLimit)

The eventDelayLimit takes a non-negative integer representing the number of milliseconds to allow the appender to block if the underlying BlockingQueue is full. Once this limit is reached, the event is dropped.

Parameters:

eventDelayLimit - the event delay limit

getEventDelayLimit

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

Returns the value of the eventDelayLimit property.