Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::varia::FallbackErrorHandler Class Reference

The FallbackErrorHandler implements the ErrorHandler interface such that a secondary appender may be specified. More...

#include <fallbackerrorhandler.h>

Inheritance diagram for log4cxx::varia::FallbackErrorHandler:
log4cxx::spi::ErrorHandler log4cxx::spi::OptionHandler log4cxx::helpers::Object

Public Member Functions

 FallbackErrorHandler ()
 ~FallbackErrorHandler ()
void addAppenderHolder (const LogString &name, const spi::AppenderAttachablePtr &clx) override
 Add clx to the list of collections to search for the failed appender.
void setLogger (const LoggerPtr &logger) override
 Adds the logger passed as parameter to the list of loggers that we need to search for in case of appender failure.
void error (const LogString &context, const std::exception &e, spi::ErrorCode category, const spi::LoggingEventPtr &event) override
 Write context and e to stderr and attempt switch to the fallback appender.
void error (const LogString &context, const std::exception &e, spi::ErrorCode category) override
 Write context and e to stderr and attempt switch to the fallback appender.
void error (const LogString &message, spi::ErrorCode category) override
 Write message to stderr.
void setAppender (const AppenderPtr &primary) override
 The appender to which this error handler is attached.
void setBackupAppender (const AppenderPtr &backup) override
 Set the backup appender.
bool errorReported () const override
 Has an error been reported?
Public Member Functions inherited from log4cxx::spi::ErrorHandler
virtual ~ErrorHandler ()
virtual void addAppenderHolder (const LogString &name, const AppenderAttachablePtr &clx)
 Override this to add clx to the list of collections to search for the failed appender.
void activateOptions () override
 Activate the options that were previously set with calls to option setters.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
void activateOptions (helpers::Pool &)
virtual void setOption (const LogString &option, const LogString &value)
 Override this method to set option to value.
Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual const helpers::Class & getClass () const =0
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Detailed Description

The FallbackErrorHandler implements the ErrorHandler interface such that a secondary appender may be specified.

This secondary appender takes over if the primary appender fails for whatever reason.

The error message is printed on System.err, and logged in the new secondary appender.

Here is a sample configuration file that installs this error handler:

<?xml version="1.0" encoding="UTF-8" ?>
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="Primary" class="RollingFileAppender">
<rollingPolicy class="TimeBasedRollingPolicy">
<param name="FileNamePattern" value="${LOG_SERVER_UNC_PATH}/${PROGRAM_FILE_PATH.STEM}-%d{yyyy-MM-dd-HH-mm-ss-SSS}.log"/>
</rollingPolicy>
<triggeringPolicy class="SizeBasedTriggeringPolicy">
<param name="MaxFileSize" value="5MB"/>
</triggeringPolicy>
<param name="File" value="${LOG_SERVER_UNC_PATH}/${PROGRAM_FILE_PATH.STEM}.log" />
<param name="BufferedIO" value="true"/>
<param name="BufferedSeconds" value="1"/>
<layout class="PatternLayout">
<param name="ConversionPattern" value="%d %-5p %c{2} - %m%n"/>
</layout>
</appender>
<appender name="Backup" class="RollingFileAppender">
<rollingPolicy class="TimeBasedRollingPolicy">
<param name="FileNamePattern" value="${PROGRAM_FILE_PATH.PARENT_PATH}/${PROGRAM_FILE_PATH.STEM}-%d{yyyy-MM-dd-HH-mm-ss-SSS}.log"/>
</rollingPolicy>
<triggeringPolicy class="SizeBasedTriggeringPolicy">
<param name="MaxFileSize" value="5MB"/>
</triggeringPolicy>
<param name="File" value="${PROGRAM_FILE_PATH.PARENT_PATH}/${PROGRAM_FILE_PATH.STEM}.log" />
<param name="BufferedIO" value="true"/>
<param name="BufferedSeconds" value="1"/>
<layout class="PatternLayout">
<param name="ConversionPattern" value="%d %-5p %c{2} - %m%n"/>
</layout>
</appender>
<appender name="ASYNC" class="AsyncAppender">
<appender-ref ref="Primary" fallback-ref="Backup"/>
</appender>
<root>
<priority value ="INFO" />
<appender-ref ref="ASYNC" />
</root>
</log4j:configuration>

Constructor & Destructor Documentation

◆ FallbackErrorHandler()

log4cxx::varia::FallbackErrorHandler::FallbackErrorHandler ( )

◆ ~FallbackErrorHandler()

log4cxx::varia::FallbackErrorHandler::~FallbackErrorHandler ( )

Member Function Documentation

◆ addAppenderHolder()

void log4cxx::varia::FallbackErrorHandler::addAppenderHolder ( const LogString & name,
const spi::AppenderAttachablePtr & clx )
override

Add clx to the list of collections to search for the failed appender.

Parameters
nameused in log messages.
clxhas a collection of appenders.

◆ error() [1/3]

void log4cxx::varia::FallbackErrorHandler::error ( const LogString & context,
const std::exception & e,
spi::ErrorCode category )
overridevirtual

Write context and e to stderr and attempt switch to the fallback appender.

On the first call to this method, the primary appender is replaced by the backup appender.

Implements log4cxx::spi::ErrorHandler.

◆ error() [2/3]

void log4cxx::varia::FallbackErrorHandler::error ( const LogString & context,
const std::exception & e,
spi::ErrorCode category,
const spi::LoggingEventPtr & event )
overridevirtual

Write context and e to stderr and attempt switch to the fallback appender.

On the first call to this method, the primary appender is replaced by the backup appender and event is sent to the backup appender.

Reimplemented from log4cxx::spi::ErrorHandler.

◆ error() [3/3]

void log4cxx::varia::FallbackErrorHandler::error ( const LogString & message,
spi::ErrorCode category )
overridevirtual

Write message to stderr.

Implements log4cxx::spi::ErrorHandler.

◆ errorReported()

bool log4cxx::varia::FallbackErrorHandler::errorReported ( ) const
overridevirtual

Has an error been reported?

Reimplemented from log4cxx::spi::ErrorHandler.

◆ setAppender()

void log4cxx::varia::FallbackErrorHandler::setAppender ( const AppenderPtr & primary)
overridevirtual

The appender to which this error handler is attached.

Reimplemented from log4cxx::spi::ErrorHandler.

◆ setBackupAppender()

void log4cxx::varia::FallbackErrorHandler::setBackupAppender ( const AppenderPtr & backup)
overridevirtual

Set the backup appender.

Reimplemented from log4cxx::spi::ErrorHandler.

◆ setLogger()

void log4cxx::varia::FallbackErrorHandler::setLogger ( const LoggerPtr & logger)
overridevirtual

Adds the logger passed as parameter to the list of loggers that we need to search for in case of appender failure.

Reimplemented from log4cxx::spi::ErrorHandler.


The documentation for this class was generated from the following file: