Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::db::ODBCAppender Class Reference

The ODBCAppender sends log events to a database. More...

#include <odbcappender.h>

Inheritance diagram for log4cxx::db::ODBCAppender:
log4cxx::AppenderSkeleton log4cxx::Appender log4cxx::spi::OptionHandler log4cxx::helpers::Object

Public Types

typedef void * SQLHDBC
typedef void * SQLHENV
typedef void * SQLHANDLE
typedef short SQLSMALLINT

Public Member Functions

 ODBCAppender ()
virtual ~ODBCAppender ()
void setOption (const LogString &option, const LogString &value) override
 Override this method to set option to value.
void activateOptions () override
 Activate the specified options.
void append (const spi::LoggingEventPtr &event) override
 Adds the event to the buffer.
void setSql (const LogString &s)
 Set pre-formated statement eg: insert into LogTable (msg) values ("%m").
const LogString & getSql () const
 Returns pre-formated statement eg: insert into LogTable (msg) values ("%m").
void setUser (const LogString &user)
void setURL (const LogString &url)
void setPassword (const LogString &password)
void setBufferSize (size_t newBufferSize)
const LogString & getUser () const
const LogString & getURL () const
const LogString & getPassword () const
size_t getBufferSize () const
Public Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (const LayoutPtr &layout={})
virtual ~AppenderSkeleton ()
void addFilter (const spi::FilterPtr &newFilter) override
 Add newFilter to end of the spi::Filter chain.
void clearFilters () override
 Clear the spi::Filter chain.
void close () override
 Release any resources allocated within the appender such as file handles, network connections, etc.
const spi::ErrorHandlerPtr getErrorHandler () const
 The currently set spi::ErrorHandler for this Appender.
spi::FilterPtr getFilter () const override
 The first spi::Filter in the filter chain for this Appender.
const spi::FilterPtr getFirstFilter () const
 The first spi::Filter in the filter chain for this Appender.
LayoutPtr getLayout () const override
 The currently set Layout for this appender.
LogString getName () const override
 The name of this Appender.
const LevelPtr getThreshold () const
 This appender's current threshold level.
bool isAsSevereAsThreshold (const LevelPtr &level) const
 Is level greater than or equal to this appender's threshold?
void doAppend (const spi::LoggingEventPtr &event) override
 Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl.
void setErrorHandler (const spi::ErrorHandlerPtr &newValue)
 Use newValue as the spi::ErrorHandler for this Appender.
void setLayout (const LayoutPtr &newValue) override
 Use newValue as the layout for this appender.
void setName (const LogString &newValue) override
 Use newValue for the name of this Appender.
void setThreshold (const LevelPtr &newValue)
 Use newValue as this appender's threshold level.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
void doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool)
virtual bool requiresLayout () const
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
void activateOptions (helpers::Pool &)
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

Protected Member Functions

virtual void closeConnection (SQLHDBC con)
 Override this to return the connection to a pool, or to clean up the resource.
virtual SQLHDBC getConnection ()
 Override this to link with your connection pooling system.
virtual void flushBuffer ()
 loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute().
Protected Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
void doAppendImpl (const spi::LoggingEventPtr &event)
 Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected.
bool isAccepted (const spi::LoggingEventPtr &event) const
 Does no attached filter deny event or does an attached filter accept event?

Detailed Description

The ODBCAppender sends log events to a database.

Each append call adds the spi::LoggingEvent to a buffer. When the buffer is full, values are extracted from each spi::LoggingEvent and the sql insert statement executed.

The SQL insert statement pattern must be provided either in the Log4cxx configuration file using the sql parameter element or programatically by calling the setSql(String sql) method.

The following param elements are optional:

  • one of DSN, URL, ConnectionString - The serverName parameter value in the SQLConnect call.
  • User - The UserName parameter value in the SQLConnect call.
  • Password - The Authentication parameter value in the SQLConnect call.
  • BufferSize - Delay executing the sql until this many logging events are available. One by default, meaning an sql statement is executed whenever a logging event is appended.
  • ColumnMapping - One element for each "?" in the sql statement in a sequence corresponding to the columns in the insert statement. The following values are supported:
    • logger - the name of the logger that generated the logging event
    • level - the level of the logging event
    • thread - the thread number as a hex string that generated the logging event
    • threadname - the name assigned to the thread that generated the logging event
    • time - a datetime or datetime2 SQL field type at which the event was generated
    • shortfilename - the basename of the file containing the logging statement
    • fullfilename - the path of the file containing the logging statement
    • line - the position in the file at which the logging event was generated
    • class - the class from which the logging event was generated (1)
    • method - the function in which the logging event was generated (1)
    • message - the data sent by the logging statement
    • mdc - A JSON format string of all entries in the logging thread's mapped diagnostic context
    • mdc{key} - the value associated with the key entry in the logging thread's mapped diagnostic context
    • ndc - the last entry the logging thread's nested diagnostic context

(1) Only available when the LOG4CXX_* macros are used to issue the logging request.

For use as a base class:

  • Override getConnection() to pass any connection you want. Typically this is used to enable application wide connection pooling.

  • Override closeConnection – if you override getConnection make sure to implement closeConnection to handle the connection you generated. Typically this would return the connection to the pool it came from.

An example configuration that writes to the data source named "LoggingDSN" is:

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="PreparedAppender" class="ODBCAppender">
<param name="DSN" value="LoggingDSN"/>
<param name="sql" value="INSERT INTO [SomeDatabaseName].[SomeUserName].[SomeTableName] ([Thread],[LogName],[LogTime],[LogLevel],[FileName],[FileLine],[Message],[MappedContext]) VALUES (?,?,?,?,?,?,?,?)" />
<param name="ColumnMapping" value="thread"/>
<param name="ColumnMapping" value="logger"/>
<param name="ColumnMapping" value="time"/>
<param name="ColumnMapping" value="level"/>
<param name="ColumnMapping" value="shortfilename"/>
<param name="ColumnMapping" value="line"/>
<param name="ColumnMapping" value="message"/>
<param name="ColumnMapping" value="mdc"/>
</appender>
<appender name="ASYNC" class="AsyncAppender">
<param name="BufferSize" value="1000"/>
<param name="Blocking" value="false"/>
<appender-ref ref="PreparedAppender"/>
</appender>
<root>
<priority value ="INFO" />
<appender-ref ref="ASYNC" />
</root>
</log4j:configuration>

You may also want to consider the DBAppender class, which uses APR in order to support logging to databases apart from ODBC.

Member Typedef Documentation

◆ SQLHANDLE

◆ SQLHDBC

◆ SQLHENV

◆ SQLSMALLINT

Constructor & Destructor Documentation

◆ ODBCAppender()

log4cxx::db::ODBCAppender::ODBCAppender ( )

◆ ~ODBCAppender()

virtual log4cxx::db::ODBCAppender::~ODBCAppender ( )
virtual

Member Function Documentation

◆ activateOptions()

void log4cxx::db::ODBCAppender::activateOptions ( )
overridevirtual

Activate the specified options.

Reimplemented from log4cxx::AppenderSkeleton.

◆ append()

void log4cxx::db::ODBCAppender::append ( const spi::LoggingEventPtr & event)
overridevirtual

Adds the event to the buffer.

When full the buffer is flushed.

Implements log4cxx::AppenderSkeleton.

◆ closeConnection()

virtual void log4cxx::db::ODBCAppender::closeConnection ( SQLHDBC con)
protectedvirtual

Override this to return the connection to a pool, or to clean up the resource.

The default behavior holds a single connection open until the appender is closed (typically when garbage collected).

◆ flushBuffer()

virtual void log4cxx::db::ODBCAppender::flushBuffer ( )
protectedvirtual

loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute().

Errors are sent to the errorHandler.

If a statement fails the LoggingEvent stays in the buffer!

◆ getBufferSize()

size_t log4cxx::db::ODBCAppender::getBufferSize ( ) const

◆ getConnection()

virtual SQLHDBC log4cxx::db::ODBCAppender::getConnection ( )
protectedvirtual

Override this to link with your connection pooling system.

By default this creates a single connection which is held open until the object is garbage collected.

◆ getPassword()

const LogString & log4cxx::db::ODBCAppender::getPassword ( ) const

◆ getSql()

const LogString & log4cxx::db::ODBCAppender::getSql ( ) const

Returns pre-formated statement eg: insert into LogTable (msg) values ("%m").

◆ getURL()

const LogString & log4cxx::db::ODBCAppender::getURL ( ) const

◆ getUser()

const LogString & log4cxx::db::ODBCAppender::getUser ( ) const

◆ setBufferSize()

void log4cxx::db::ODBCAppender::setBufferSize ( size_t newBufferSize)

◆ setOption()

void log4cxx::db::ODBCAppender::setOption ( const LogString & option,
const LogString & value )
overridevirtual

Override this method to set option to value.

Supported options Supported values Default value
BufferSize {int} 1
ConnectionString {any} -
URL {any} -
DSN {any} -
User {any} -
Password {any} -
SQL {any} -
ColumnMapping (^) -

(^) One value for each '?' character in the SQL value.

See also
AppenderSkeleton::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

◆ setPassword()

void log4cxx::db::ODBCAppender::setPassword ( const LogString & password)

◆ setSql()

void log4cxx::db::ODBCAppender::setSql ( const LogString & s)

Set pre-formated statement eg: insert into LogTable (msg) values ("%m").

◆ setURL()

void log4cxx::db::ODBCAppender::setURL ( const LogString & url)

◆ setUser()

void log4cxx::db::ODBCAppender::setUser ( const LogString & user)

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