org.apache.logging.log4j.core.appender

Class FailoverAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.core.appender.FailoverAppender

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

@Plugin(name="Failover",
        category="Core",
        elementType="appender",
        printObject=true)
public final class FailoverAppender
extends AbstractAppender

The FailoverAppender will capture exceptions in an Appender and then route the event to a different appender. Hopefully it is obvious that the Appenders must be configured to not suppress exceptions for the FailoverAppender to work.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

AbstractAppender.Builder<B extends AbstractAppender.Builder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent event) Handle the Log event.
static FailoverAppender	createAppender(String name, String primary, String[] failovers, String retryIntervalSeconds, Configuration config, Filter filter, String ignore) Create a Failover Appender.
void	start() Make the Filter available for use.
String	toString()

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, stop, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, stop

Method Detail

start

public void start()

Description copied from class: AbstractFilterable

Make the Filter available for use.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractFilterable

append

public void append(LogEvent event)

Handle the Log event.

Parameters:

event - The LogEvent.

toString

public String toString()

Overrides:

toString in class AbstractAppender

createAppender

@PluginFactory
public static FailoverAppender createAppender(@PluginAttribute(value="name")
                                                             String name,
                                                             @PluginAttribute(value="primary")
                                                             String primary,
                                                             @PluginElement(value="Failovers")
                                                             String[] failovers,
                                                             @PluginAliases(value="retryInterval") @PluginAttribute(value="retryIntervalSeconds")
                                                             String retryIntervalSeconds,
                                                             @PluginConfiguration
                                                             Configuration config,
                                                             @PluginElement(value="Filter")
                                                             Filter filter,
                                                             @PluginAttribute(value="ignoreExceptions")
                                                             String ignore)

Create a Failover Appender.

Parameters:

name - The name of the Appender (required).

primary - The name of the primary Appender (required).

failovers - The name of one or more Appenders to fail over to (at least one is required).

retryIntervalSeconds - The retry interval in seconds.

config - The current Configuration (passed by the Configuration when the appender is created).

filter - A Filter (optional).

ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

Returns:

The FailoverAppender that was created.