net.logstash.logback.appender.listener

Class FailureSummaryAppenderListener<Event extends DeferredProcessingAware>

java.lang.Object

net.logstash.logback.appender.listener.FailureSummaryAppenderListener<Event>

All Implemented Interfaces:

AppenderListener<Event>, TcpAppenderListener<Event>

Direct Known Subclasses:

FailureSummaryLoggingAppenderListener

public abstract class FailureSummaryAppenderListener<Event extends DeferredProcessingAware>
extends Object
implements TcpAppenderListener<Event>

A TcpAppenderListener that invokes different callbacks for the first successful append/send/connect after a series of failures. The callback includes a summary of the failures that occurred.

Subclasses implement handleFailureSummary(FailureSummary, CallbackType) to define behavior when the first successful append/send/connect occurs after a series of consecutive failures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FailureSummaryAppenderListener.CallbackType The type of listener callback.
static interface	FailureSummaryAppenderListener.FailureSummary Summary details of consecutive failures

Constructor Summary

Constructors

Constructor and Description
FailureSummaryAppenderListener()

Method Summary

Modifier and Type	Method and Description
void	appenderStarted(Appender<Event> appender) Called when the given appender is started.
void	appenderStopped(Appender<Event> appender) Called when the given appender is stopped.
void	connectionClosed(Appender<Event> appender, Socket socket) Called after the given appender closes the given socket (either due to a reconnect, or shutdown)
void	connectionFailed(Appender<Event> appender, InetSocketAddress address, Throwable reason) Called after the given appender fails to open a socket
void	connectionOpened(Appender<Event> appender, Socket socket) Called after the given appender successfully opens the given socket
void	eventAppended(Appender<Event> appender, Event event, long durationInNanos) Called when the given event was successfully appended by the given appender.
void	eventAppendFailed(Appender<Event> appender, Event event, Throwable reason) Called when the given event was failed to be appended by the given appender.
void	eventSendFailure(Appender<Event> appender, Event event, Throwable reason) Called when the given appender fails to send the given event over a TCP connection.
void	eventSent(Appender<Event> appender, Socket socket, Event event, long durationInNanos) Called after given appender successfully sent the given event over the TCP connection.
protected abstract void	handleFailureSummary(FailureSummaryAppenderListener.FailureSummary failureSummary, FailureSummaryAppenderListener.CallbackType callbackType) Called after the first success after the a series of consecutive failures.

Methods inherited from class java.lang.Object

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

Constructor Detail

FailureSummaryAppenderListener

public FailureSummaryAppenderListener()

Method Detail

appenderStarted

public void appenderStarted(Appender<Event> appender)

Description copied from interface: AppenderListener

Called when the given appender is started.

Specified by:

appenderStarted in interface AppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that was started

appenderStopped

public void appenderStopped(Appender<Event> appender)

Description copied from interface: AppenderListener

Called when the given appender is stopped.

Specified by:

appenderStopped in interface AppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that was stopped

eventAppended

public void eventAppended(Appender<Event> appender,
                          Event event,
                          long durationInNanos)

Description copied from interface: AppenderListener

Called when the given event was successfully appended by the given appender. Note that for Asynchronous appenders, this generally means that the event was accepted for processing, but hasn't finished processing yet.

Specified by:

eventAppended in interface AppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender when successfully appended the event

event - the event that was appended

durationInNanos - the time (in nanoseconds) it took to append the event

eventAppendFailed

public void eventAppendFailed(Appender<Event> appender,
                              Event event,
                              Throwable reason)

Description copied from interface: AppenderListener

Called when the given event was failed to be appended by the given appender.

Specified by:

eventAppendFailed in interface AppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender when successfully appended the event

event - the event that was appended

reason - what caused the failure

eventSent

public void eventSent(Appender<Event> appender,
                      Socket socket,
                      Event event,
                      long durationInNanos)

Description copied from interface: TcpAppenderListener

Called after given appender successfully sent the given event over the TCP connection.

Specified by:

eventSent in interface TcpAppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that sent the event

socket - the socket over which the appender sent the event

event - the event that was sent

durationInNanos - the time (in nanoseconds) it took to send the event

eventSendFailure

public void eventSendFailure(Appender<Event> appender,
                             Event event,
                             Throwable reason)

Description copied from interface: TcpAppenderListener

Called when the given appender fails to send the given event over a TCP connection.

Specified by:

eventSendFailure in interface TcpAppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that attempted to send the event

event - the event that failed to send

reason - what caused the failure

connectionOpened

public void connectionOpened(Appender<Event> appender,
                             Socket socket)

Description copied from interface: TcpAppenderListener

Called after the given appender successfully opens the given socket

Specified by:

connectionOpened in interface TcpAppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that opened the socket

socket - the socket that was opened

connectionFailed

public void connectionFailed(Appender<Event> appender,
                             InetSocketAddress address,
                             Throwable reason)

Description copied from interface: TcpAppenderListener

Called after the given appender fails to open a socket

Specified by:

connectionFailed in interface TcpAppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that attempted to open a socket

address - the address to which the appender attempted to connect

reason - what caused the failure

connectionClosed

public void connectionClosed(Appender<Event> appender,
                             Socket socket)

Description copied from interface: TcpAppenderListener

Called after the given appender closes the given socket (either due to a reconnect, or shutdown)

Specified by:

connectionClosed in interface TcpAppenderListener<Event extends DeferredProcessingAware>

Parameters:

appender - the appender that closed the socket

socket - the socket that was closed

handleFailureSummary

protected abstract void handleFailureSummary(FailureSummaryAppenderListener.FailureSummary failureSummary,
                                             FailureSummaryAppenderListener.CallbackType callbackType)

Called after the first success after the a series of consecutive failures.

Parameters:

failureSummary - contains summary details of all the consecutive failures

callbackType - the type of callback (append/send/connect)