com.protomatter.syslog
Class SyslogHandler

com.protomatter.syslog.SyslogHandler

public class SyslogHandler

A JDK 1.4 logging system handler to route messages into Syslog. Logger names are converted to syslog channel names.

The following log properties file assigns the SyslogHandler class as the only log handler.

  .level = ALL

  handlers = com.protomatter.syslog.SyslogHandler  

  

Here's a usage example:

  import java.util.logging.Logger;

  ...

  // Make a new logger
  Logger myLogger = Logger.getLogger("foo.bar");

  // Write some log messages
  myLogger.info("Info message to my logger");
  myLogger.warning("Warning message to my logger");
  myLogger.severe("Severe message to my logger");

  

If you have syslog configured to show the channel name and log all message levels, you'll see something like this:

   11/01/2001 20:09:16 [INFO] [foo.bar        ] Test.main():23      Info message to my logger
   11/01/2001 20:09:16 [WARN] [foo.bar        ] Test.main():25      Warning message to my logger  
   11/01/2001 20:09:16 [EROR] [foo.bar        ] Test.main():27      Severe message to my logger
  

If the "SyslogHandler.xml" system property is set, this class will call SyslogXML.configure() with that configuration file.

So, to configure syslog and use the JDK 1.4 logging API to write to it, do the following:

  java \
    ...
    -DSyslogHandler.xml=/path/to/syslog.xml                        \  
    -Djava.util.logging.config.file=/path/to/logging.properties    \  
    ...
    java-main-class

  

Constructor Summary

SyslogHandler()
Create a new handler for routing messages to Syslog.

Method Summary

void	close() Close the handler.
void	flush() Flush this handler.
java.util.Map	getLevelMap() Get the conversion map for levels.
void	publish(com.protomatter.syslog.LogRecord record) Route the given log record into Syslog.
void	resetLevelMap() Reset the level conversion map to the default.
void	setLevelMap(java.util.Map levelMap) Set the conversion map for levels.

Constructor Detail

SyslogHandler

public SyslogHandler()

Create a new handler for routing messages to Syslog.

Method Detail

resetLevelMap

public void resetLevelMap()

Reset the level conversion map to the default. The default map is:

java.util.logging.Level	Syslog Level
Level.SEVERE	Syslog.ERROR
Level.WARNING	Syslog.WARNING
Level.INFO	Syslog.INFO
Level.CONFIG	Syslog.DEBUG
Level.FINE	Syslog.DEBUG
Level.FINER	Syslog.DEBUG
Level.FINEST	Syslog.DEBUG

close

public void close()

Close the handler.

flush

public void flush()

Flush this handler. This method simply calls Syslog.flush().

See Also:

Syslog.flush()

publish

public void publish(com.protomatter.syslog.LogRecord record)

Route the given log record into Syslog. If this handler has been closed, the record is ignored. If a filter has been set, then it is applied to record to see if it should be passed on to Syslog.

If a formatter has been set, it is used to format the message. If it has not been set, then the record's message is used as-is.

If a throwable has been set, it is used as the message detail when the record is sent to Syslog.

The log level is converted from a java.util.logging.Level according to the level map for this handler.

The name of the java.util.logging.Logger is used as the channel name.

Once these conversions have been made, the information is passed onto Syslog for further processing.

getLevelMap

public java.util.Map getLevelMap()

Get the conversion map for levels. The key in the map is an instance of java.util.logging.Level and the value is a java.lang.Integer which is a wrapper for Syslog.DEBUG, Syslog.INFO, etc.

setLevelMap

public void setLevelMap(java.util.Map levelMap)

Set the conversion map for levels. The key in the map is an instance of java.util.logging.Level and the value is a java.lang.Integer which is a wrapper for Syslog.DEBUG, Syslog.INFO, etc.