Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::net::JSONSocketAppender Class Reference

Sends spi::LoggingEvent elements to a remote a log server, usually in JSON format. More...

#include <jsonsocketappender.h>

Inheritance diagram for log4cxx::net::JSONSocketAppender:
log4cxx::net::SocketAppenderSkeleton log4cxx::AppenderSkeleton log4cxx::Appender log4cxx::spi::OptionHandler log4cxx::helpers::Object

Public Member Functions

 JSONSocketAppender ()
 An unconnected appender using the default port.
 ~JSONSocketAppender ()
 Close and shutdown the connection if not already done.
 JSONSocketAppender (const helpers::InetAddressPtr &address, int port)
 Connects to remote server at address and port.
 JSONSocketAppender (const LogString &host, int port)
 Connects to remote server at host and port.
Public Member Functions inherited from log4cxx::net::SocketAppenderSkeleton
 SocketAppenderSkeleton (int defaultPort, int millisecondDelay)
 A unconnected appender sending to defaultPort, with a retry after millisecondDelay when unable to establish a connection.
 ~SocketAppenderSkeleton ()
 Close and shutdown the connection if not already done.
 SocketAppenderSkeleton (const helpers::InetAddressPtr &address, int port, int millisecondDelay)
 A remote server at address and port, with a retry after millisecondDelay when unable to establish a connection.
 SocketAppenderSkeleton (const LogString &host, int port, int millisecondDelay)
 A remote server at host and port, with a retry after millisecondDelay when unable to establish a connection.
void activateOptions () override
 Connects to the configured RemoteHost and Port.
void append (const spi::LoggingEventPtr &event) override
 Sends the message that the configured Layout produces from event to the output sink.
void setRemoteHost (const LogString &newValue)
 Use newValue as the name of the server.
const LogString & getRemoteHost () const
 Returns value of the RemoteHost option.
void setPort (int newValue)
 Use newValue, which must be a positive integer, as the port on which the server is waiting for connections.
int getPort () const
 Returns value of the Port option.
void setReconnectionDelay (int millisecondDelay)
 Use millisecondDelay as the number of milliseconds to wait between each failed connection attempt to the server.
int getReconnectionDelay () const
 The value of the ReconnectionDelay option, the number of milliseconds to wait between each failed connection attempt to the server.
void setSocketSubclass (const LogString &newSubclass)
 Use newSubclass as the helpers::Socket interface instead of the default implementation.
const LogString & getSocketSubclass () const
 The class name used for the helpers::Socket interface implemention.
void setOption (const LogString &option, const LogString &value) override
 Override this method to set option to value.
void activateOptions (helpers::Pool &)
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

int getDefaultDelay () const override
int getDefaultPort () const override
Protected Member Functions inherited from log4cxx::net::SocketAppenderSkeleton
 SocketAppenderSkeleton (std::unique_ptr< SocketAppenderSkeletonPriv > priv)
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

Sends spi::LoggingEvent elements to a remote a log server, usually in JSON format.

Here is an example configuration that writes JSON to the TCP input plugin of a fluent-bit log server running on the same system as the application:

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="A1" class="JSONSocketAppender">
<param name="RemoteHost" value="localhost" />
<param name="Port" value="5170" />
<param name="Threshold" value="INFO" />
</appender>
<root>
<priority value ="INFO" />
<appender-ref ref="A1" />
</root>
</log4j:configuration>

See SocketAppenderSkeleton for more information on the behaviour this appender.

Constructor & Destructor Documentation

◆ JSONSocketAppender() [1/3]

log4cxx::net::JSONSocketAppender::JSONSocketAppender ( )

An unconnected appender using the default port.

◆ ~JSONSocketAppender()

log4cxx::net::JSONSocketAppender::~JSONSocketAppender ( )

Close and shutdown the connection if not already done.

◆ JSONSocketAppender() [2/3]

log4cxx::net::JSONSocketAppender::JSONSocketAppender ( const helpers::InetAddressPtr & address,
int port )

Connects to remote server at address and port.

◆ JSONSocketAppender() [3/3]

log4cxx::net::JSONSocketAppender::JSONSocketAppender ( const LogString & host,
int port )

Connects to remote server at host and port.

Member Function Documentation

◆ getDefaultDelay()

int log4cxx::net::JSONSocketAppender::getDefaultDelay ( ) const
overrideprotectedvirtual

◆ getDefaultPort()

int log4cxx::net::JSONSocketAppender::getDefaultPort ( ) const
overrideprotectedvirtual

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