|
Apache Log4cxx
Version 2.0.0
|
Use SyslogAppender to send log messages to a remote syslog daemon. More...
#include <syslogappender.h>
Public Member Functions | |
| SyslogAppender () | |
| SyslogAppender (const LayoutPtr &layout, int syslogFacility) | |
| SyslogAppender (const LayoutPtr &layout, const LogString &syslogHost, int syslogFacility) | |
| ~SyslogAppender () | |
| void | append (const spi::LoggingEventPtr &event) override |
Subclasses of AppenderSkeleton must implement this method to perform actual logging. | |
| void | setOption (const LogString &option, const LogString &value) override |
Override this method to set option to value. | |
| void | setSyslogHost (const LogString &syslogHost) |
| The SyslogHost option is the name of the the syslog host where log output should go. | |
| const LogString & | getSyslogHost () const |
| Returns the value of the SyslogHost option. | |
| void | setFacility (const LogString &facilityName) |
| Set the syslog facility. | |
| LogString | getFacility () const |
| Returns the value of the Facility option. | |
| void | setFacilityPrinting (bool facilityPrinting1) |
| If the FacilityPrinting option is set to true, the printed message will include the facility name of the application. | |
| bool | getFacilityPrinting () const |
| Returns the value of the FacilityPrinting option. | |
| void | setMaxMessageLength (int maxMessageLength1) |
| int | getMaxMessageLength () const |
| void | setFormat (const LogString &format) |
| Set the format of messages sent to a remote syslog daemon. | |
| LogString | getFormat () const |
| Returns the value of the Format option, either "BSD" or "RFC5424". | |
| void | setAppName (const LogString &appName) |
| Set the APP-NAME field of messages in the RFC5424 format. | |
| const LogString & | getAppName () const |
| Returns the value of the AppName option. | |
| void | setMessageId (const LogString &messageId) |
| Set the MSGID field of messages in the RFC5424 format. | |
| const LogString & | getMessageId () const |
| Returns the value of the MessageId option. | |
| Public Member Functions inherited from log4cxx::AppenderSkeleton | |
| AppenderSkeleton (const LayoutPtr &layout={}) | |
| virtual | ~AppenderSkeleton () |
| void | activateOptions () override |
| Activate the options that were previously set with calls to option setters. | |
| 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 |
Static Public Member Functions | |
| static LogString | getFacilityString (int syslogFacility) |
| Returns the specified syslog facility as a lower-case String, e.g. | |
| static int | getFacility (const LogString &facilityName) |
| Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized. | |
Protected Member Functions | |
| void | initSyslogFacilityStr () |
| 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? | |
Use SyslogAppender to send log messages to a remote syslog daemon.
Note that by default, this appender will split up messages that are more than 1024 bytes long, for compatability with BSD syslog(see RFC 3164). Modern syslog implementations(e.g. syslog-ng) can accept messages much larger, and may have a default of 8k. You may modify the default size of the messages by setting the MaxMessageLength option.
When the message is too large for the current MaxMessageLength, the packet number and total # will be appended to the end of the message like this: (5/10)
By default, a message sent to a remote syslog daemon contains only the priority and the formatted message, as in BSD syslog (RFC 3164). Set the Format option to RFC5424 to send messages using the syslog protocol (see RFC 5424), which adds the protocol version, a UTC timestamp, the local host name, the AppName option value, the process identifier and the MessageId option value to each message, for example:
<14>1 2026-11-11T09:30:15.003210Z myhost myapp 4321 - - Hello world
The Format option has no effect when messages are sent using the system function 'syslog' on the local host.
| log4cxx::net::SyslogAppender::SyslogAppender | ( | ) |
| log4cxx::net::SyslogAppender::SyslogAppender | ( | const LayoutPtr & | layout, |
| int | syslogFacility ) |
| log4cxx::net::SyslogAppender::SyslogAppender | ( | const LayoutPtr & | layout, |
| const LogString & | syslogHost, | ||
| int | syslogFacility ) |
| log4cxx::net::SyslogAppender::~SyslogAppender | ( | ) |
|
overridevirtual |
Subclasses of AppenderSkeleton must implement this method to perform actual logging.
See also AppenderSkeleton::doAppend method.
Implements log4cxx::AppenderSkeleton.
| const LogString & log4cxx::net::SyslogAppender::getAppName | ( | ) | const |
Returns the value of the AppName option.
| LogString log4cxx::net::SyslogAppender::getFacility | ( | ) | const |
Returns the value of the Facility option.
|
static |
Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized.
| facilityName | one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The matching is case-insensitive. |
| bool log4cxx::net::SyslogAppender::getFacilityPrinting | ( | ) | const |
Returns the value of the FacilityPrinting option.
|
static |
Returns the specified syslog facility as a lower-case String, e.g.
"kern", "user", etc.
| LogString log4cxx::net::SyslogAppender::getFormat | ( | ) | const |
Returns the value of the Format option, either "BSD" or "RFC5424".
| int log4cxx::net::SyslogAppender::getMaxMessageLength | ( | ) | const |
| const LogString & log4cxx::net::SyslogAppender::getMessageId | ( | ) | const |
Returns the value of the MessageId option.
| const LogString & log4cxx::net::SyslogAppender::getSyslogHost | ( | ) | const |
Returns the value of the SyslogHost option.
|
protected |
| void log4cxx::net::SyslogAppender::setAppName | ( | const LogString & | appName | ) |
Set the APP-NAME field of messages in the RFC5424 format.
This is the AppName option.
An empty value sends the nil value ("-"). Characters that are not printable US-ASCII, including spaces, are replaced with '_' and the value is truncated to 48 characters.
| void log4cxx::net::SyslogAppender::setFacility | ( | const LogString & | facilityName | ) |
Set the syslog facility.
This is the Facility option.
The facilityName parameter must be one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is unimportant.
| void log4cxx::net::SyslogAppender::setFacilityPrinting | ( | bool | facilityPrinting1 | ) |
If the FacilityPrinting option is set to true, the printed message will include the facility name of the application.
It is false by default.
| void log4cxx::net::SyslogAppender::setFormat | ( | const LogString & | format | ) |
Set the format of messages sent to a remote syslog daemon.
This is the Format option.
The format parameter must be either BSD (see RFC 3164) or RFC5424. Case is unimportant. An unknown value is ignored.
| void log4cxx::net::SyslogAppender::setMaxMessageLength | ( | int | maxMessageLength1 | ) |
| void log4cxx::net::SyslogAppender::setMessageId | ( | const LogString & | messageId | ) |
Set the MSGID field of messages in the RFC5424 format.
This is the MessageId option.
An empty value sends the nil value ("-"). Characters that are not printable US-ASCII, including spaces, are replaced with '_' and the value is truncated to 32 characters.
|
overridevirtual |
Override this method to set option to value.
| Supported options | Supported values | Default value |
|---|---|---|
| SysLogHost | (1) | - |
| Facility | (2) | - |
| MaxMessageLength | {int} | 1024 |
| Format | BSD,RFC5424 | BSD |
| AppName | (3) | - |
| MessageId | (3) | - |
(1) A valid internet address, optionally with the port number as a suffix after a ':'.
(2) One of kern,user,mail,daemon,auth,syslog,lpr,news,uucp,cron,ftp,local0,local1,local2,local3,local4,local5,local6,local7
(3) A string of printable US-ASCII characters without spaces, used only by the RFC5424 format
Reimplemented from log4cxx::AppenderSkeleton.
| void log4cxx::net::SyslogAppender::setSyslogHost | ( | const LogString & | syslogHost | ) |
The SyslogHost option is the name of the the syslog host where log output should go.
WARNING If the SyslogHost is not set, then this appender will fail.