Log4j 1.1b7

org.apache.log4j
Class PropertyConfigurator

java.lang.Object
  |
  +--org.apache.log4j.BasicConfigurator
        |
        +--org.apache.log4j.PropertyConfigurator
All Implemented Interfaces:
Configurator

public class PropertyConfigurator
extends BasicConfigurator
implements Configurator

Extends BasicConfigurator to provide configuration from an external file. See doConfigure(String, Hierarchy) for the expected format.

It is sometimes useful to see how log4j is reading configuration files. You can enable log4j internal logging by defining the log4j.configDebug variable.

As of log4j version 0.8.5, at the initialization of the Category class, the file log4j.properties will be searched from the search path used to load classes. If the file can be found, then it will be fed to the configure(java.net.URL) method.

The PropertyConfigurator does not handle the advanced configuration features supported by the DOMConfigurator such as support for sub-classing of the Priority class, Filters, custom ErrorHandlers, nested appenders such as the AsyncAppender, etc.

All option values admit variable substitution. For example, if java.home system property is set to /home/xyz and the File option is set to the string ${java.home}/test.log, then File option will be interpreted as the string /home/xyz/test.log.

The value of the substituted variable can be defined as a system property or in the configuration file file itself.

The syntax of variable substituion is similar to that of UNIX shells. The string between an opening "${" and closing "}" is interpreted as a key. Its value is searched in the system properties, and if not founf then in the configuration file being parsed. The corresponding value replaces the ${variableName} sequence.

Since:
0.8.1
Author:
Ceki Gülcü, Anders Kristensen

Field Summary
protected  CategoryFactory categoryFactory
           
protected  Hashtable registry
          Used internally to keep track of configured appenders.
 
Fields inherited from class org.apache.log4j.BasicConfigurator
DISABLE_KEY, DISABLE_OVERRIDE_KEY, INHERITED
 
Constructor Summary
PropertyConfigurator()
           
 
Method Summary
static void configure(Properties properties)
          Read configuration options from properties.
static void configure(String configFilename)
           
static void configure(URL configURL)
          Read configuration options from url configURL.
static void configureAndWatch(String configFilename)
          Like configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
static void configureAndWatch(String configFilename, long delay)
          Read the configuration file configFilename if it exists.
 void doConfigure(Properties properties, Hierarchy hierarchy)
          Read configuration options from properties.
 void doConfigure(String configFileName, Hierarchy hierarchy)
          Read configuration from a file.
 void doConfigure(URL configURL, Hierarchy hierarchy)
          Read configuration options from url configURL.
protected  void parseCatsAndRenderers(Properties props, Hierarchy hierarchy)
          Parse non-root elements, such non-root categories and renderers.
 
Methods inherited from class org.apache.log4j.BasicConfigurator
addRenderer, configure, configure, disable, disable, disableAll, disableDebug, disableInfo, enableAll, resetConfiguration, resetConfiguration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

registry

protected Hashtable registry
Used internally to keep track of configured appenders.

categoryFactory

protected CategoryFactory categoryFactory
Constructor Detail

PropertyConfigurator

public PropertyConfigurator()
Method Detail

doConfigure

public void doConfigure(String configFileName,
                        Hierarchy hierarchy)
Read configuration from a file. The existing configuration is not cleared nor reset. If you require a different call, behaviour, then call resetConfiguration method before calling doConfigure.

The configuration file consists of staments in the format key=value.

Appender configuration

Appender configuration syntax is:

# For appender named appenderName, set its class.
# Note: The appender name can contain dots.
log4j.appender.appenderName=fully.qualified.name.of.appender.class

# Set appender specific options.
log4j.appender.appenderName.option1=value1  
...
log4j.appender.appenderName.optionN=valueN
For each named appender you can configure its Layout. The syntax for configuring an appender's layout is:
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1=value1
....
log4j.appender.appenderName.layout.optionN=valueN

Configuring categories

The syntax for configuring the root category is:

log4j.rootCategory=[FATAL|ERROR|WARN|INFO|DEBUG], appenderName, appenderName, ...

This syntax means that one of the strings values ERROR, WARN, INFO or DEBUG can be supplied followed by appender names separated by commas.

If one of the optional priority values ERROR, WARN, INFO or DEBUG is given, the root priority is set to the corresponding priority. If no priority value is specified, then the root priority remains untouched.

The root category can be assigned multiple appenders.

Each appenderName (seperated by commas) will be added to the root category. The named appender is defined using the appender syntax defined above.

For non-root categories the syntax is almost the same:

log4j.category.category_name=[INHERITED|FATAL|ERROR|WARN|INFO|DEBUG], appenderName, appenderName, ...

Thus, one of the usual priority values FATAL, ERROR, WARN, INFO, or DEBUG can be optionally specified. For any any of these values the named category is assigned the corresponding priority. In addition however, the value INHERITED can be optionally specified which means that named category should inherit its priority from the category hierarchy.

If no priority value is supplied, then the priority of the named category remains untouched.

By default categories inherit their priority from the hierarchy. However, if you set the priority of a category and later decide that that category should inherit its priority, then you should specify INHERITED as the value for the priority value.

Similar to the root category syntax, each appenderName (seperated by commas) will be attached to the named category.

See the appender additivity rule in the user manual for the meaning of the additivity flag.

The user can override any of the Hierarchy.disable(java.lang.String) family of methods by setting the a key "log4j.disableOverride" to true or any value other than false. As in

 log4j.disableOverride=true 

ObjectRenderers

You can customize the way message objects of a given type are converted to String before being logged. This is done by specifying an ObjectRenderer for the object type would like to customize.

The syntax is:

log4j.renderer.fully.qualified.name.of.rendered.class=fully.qualified.name.of.rendering.class
As in,
log4j.renderer.my.Fruit=my.FruitRenderer

Class Factories

In case you are using your own sub-types of the Category class and wish to use configuration files, then you must set the categoryFactory for the sub-type that you are using.

The syntax is:

log4j.categoryFactory=fully.qualified.name.of.categoryFactory.class
See MyCategory for an example.

Example

An example configuration is given below. Other configuration file examples are given in Sort class documentation.


# Set options for appender named "A1". 
# Appender "A1" will be a SyslogAppender
log4j.appender.A1=org.apache.log4j.net.SyslogAppender

# The syslog daemon resides on www.abc.net
log4j.appender.A1.SyslogHost=www.abc.net

# A1's layout is a PatternLayout, using the conversion pattern 
# %r %-5p %c{2} %M.%L %x - %m\n. Thus, the log output will
# include # the relative time since the start of the application in
# milliseconds, followed by the priority of the log request,
# followed by the two rightmost components of the category name,
# followed by the callers method name, followed by the line number,
# the nested disgnostic context and finally the message itself.
# Refer to the documentation of PatternLayout for further information
# on the syntax of the ConversionPattern key.    
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %c{2} %M.%L %x - %m\n

# Set options for appender named "A2"
# A2 should be a RollingFileAppender, with maximum file size of 10 MB
# using at most one backup file. A2's layout is TTCC, using the
# ISO8061 date format with context printing enabled.    
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.MaxFileSize=10MB
log4j.appender.A2.MaxBackupIndex=1
log4j.appender.A2.layout=org.apache.log4j.TTCCLayout
log4j.appender.A2.layout.ContextPrinting=enabled
log4j.appender.A2.layout.DateFormat=ISO8601

# Root category set to DEBUG using the A2 appender defined above.
log4j.rootCategory=DEBUG, A2

# Category definions:
# The SECURITY category inherits is priority from root. However, it's output
# will go to A1 appender defined above. It's additivity is non-cumulative.
log4j.category.SECURITY=INHERIT, A1
log4j.additivity.SECURITY=false

# Only warnings or above will be logged for the category "SECURITY.access".
# Output will go to A1.
log4j.category.SECURITY.access=WARN


# The category "class.of.the.day" inherits its priority from the
# category hierrarchy.  Output will go to the appender's of the root
# category, A2 in this case.
log4j.category.class.of.the.day=INHERIT

Refer to the setOption method in each Appender and Layout for class specific options.

Use the # or ! characters at the beginning of a line for comments.

Parameters:
configFileName - The name of the configuration file where the configuration information is stored.

configure

public static void configure(String configFilename)

configure

public static void configure(URL configURL)
Read configuration options from url configURL.
Since:
0.8.2

configure

public static void configure(Properties properties)
Read configuration options from properties. See doConfigure(String, Hierarchy) for the expected format.

configureAndWatch

public static void configureAndWatch(String configFilename)
Like configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
Parameters:
configFilename - A file in key=value format.

configureAndWatch

public static void configureAndWatch(String configFilename,
                                     long delay)
Read the configuration file configFilename if it exists. Moreover, a thread will be created that will periodically check if configFilename has been created or modified. The period is determined by the delay argument. If a change or file creation is detected, then configFilename is read to configure log4j.
Parameters:
configFilename - A file in key=value format.
delay - The delay in milliseconds to wait between each check.

doConfigure

public void doConfigure(Properties properties,
                        Hierarchy hierarchy)
Read configuration options from properties. See doConfigure(String, Hierarchy) for the expected format.

doConfigure

public void doConfigure(URL configURL,
                        Hierarchy hierarchy)
Read configuration options from url configURL.
Specified by:
doConfigure in interface Configurator
Following copied from interface: org.apache.log4j.spi.Configurator
Parameters:
url - The URL to parse
hierarchy - The hierarchy to operation upon.

parseCatsAndRenderers

protected void parseCatsAndRenderers(Properties props,
                                     Hierarchy hierarchy)
Parse non-root elements, such non-root categories and renderers.

Log4j 1.1b7

Please notify me about new log4j releases.