Log4j Version 1.2.14: Class SyslogAppender

org.apache.log4j.net Class SyslogAppender

java.lang.Object
  |
  +--org.apache.log4j.AppenderSkeleton
        |
        +--org.apache.log4j.net.SyslogAppender

All Implemented Interfaces:

Appender, OptionHandler

public class SyslogAppender

extends AppenderSkeleton

Use SyslogAppender to send log messages to a remote syslog daemon.

Author:

Ceki Gülcü, Anders Kristensen

LOG_KERN

public static final int LOG_KERN

Kernel messages

LOG_USER

public static final int LOG_USER

Random user-level messages

LOG_MAIL

public static final int LOG_MAIL

Mail system

LOG_DAEMON

public static final int LOG_DAEMON

System daemons

LOG_AUTH

public static final int LOG_AUTH

security/authorization messages

LOG_SYSLOG

public static final int LOG_SYSLOG

messages generated internally by syslogd

LOG_LPR

public static final int LOG_LPR

line printer subsystem

LOG_NEWS

public static final int LOG_NEWS

network news subsystem

LOG_UUCP

public static final int LOG_UUCP

UUCP subsystem

LOG_CRON

public static final int LOG_CRON

clock daemon

LOG_AUTHPRIV

public static final int LOG_AUTHPRIV

security/authorization messages (private)

LOG_FTP

public static final int LOG_FTP

ftp daemon

LOG_LOCAL0

public static final int LOG_LOCAL0

reserved for local use

LOG_LOCAL1

public static final int LOG_LOCAL1

reserved for local use

LOG_LOCAL2

public static final int LOG_LOCAL2

reserved for local use

LOG_LOCAL3

public static final int LOG_LOCAL3

reserved for local use

LOG_LOCAL4

public static final int LOG_LOCAL4

reserved for local use

LOG_LOCAL5

public static final int LOG_LOCAL5

reserved for local use

LOG_LOCAL6

public static final int LOG_LOCAL6

reserved for local use

LOG_LOCAL7

public static final int LOG_LOCAL7

reserved for local use

SYSLOG_HOST_OI

protected static final int SYSLOG_HOST_OI

FACILITY_OI

protected static final int FACILITY_OI

SyslogAppender

public SyslogAppender()

SyslogAppender

public SyslogAppender(Layout layout,
                      int syslogFacility)

SyslogAppender

public SyslogAppender(Layout layout,
                      String syslogHost,
                      int syslogFacility)

close

public void close()

Release any resources held by this SyslogAppender.

Since:

0.8.4

getFacilityString

public static String getFacilityString(int syslogFacility)

Returns the specified syslog facility as a lower-case String, e.g. "kern", "user", etc.

getFacility

public static int getFacility(String facilityName)

Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized.

Parameters:

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.

Since:

1.1

append

public void append(LoggingEvent event)

Description copied from class: AppenderSkeleton

Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton.doAppend method.

Overrides:

append in class AppenderSkeleton

activateOptions

public void activateOptions()

This method returns immediately as options are activated when they are set.

Overrides:

activateOptions in class AppenderSkeleton

requiresLayout

public boolean requiresLayout()

The SyslogAppender requires a layout. Hence, this method returns true.

Since:

0.8.4

setSyslogHost

public void setSyslogHost(String syslogHost)

The SyslogHost option is the name of the the syslog host where log output should go. A non-default port can be specified by appending a colon and port number to a host name, an IPv4 address or an IPv6 address enclosed in square brackets. WARNING If the SyslogHost is not set, then this appender will fail.

getSyslogHost

public String getSyslogHost()

Returns the value of the SyslogHost option.

setFacility

public void setFacility(String 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.

Since:

0.8.1

getFacility

public String getFacility()

Returns the value of the Facility option.

setFacilityPrinting

public void setFacilityPrinting(boolean on)

If the FacilityPrinting option is set to true, the printed message will include the facility name of the application. It is false by default.

getFacilityPrinting

public boolean getFacilityPrinting()

Returns the value of the FacilityPrinting option.