Class LoggerConfiguratorIni

Description

Implements interfaces:

Allows the configuration of log4php from an external file.

This is the most commonly used method of configuring log4php.

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

The LoggerConfiguratorIni does not handle the advanced configuration features supported by the LoggerConfiguratorXml such as support for LoggerFilter, custom LoggerErrorHandlers, nested appenders such as the AsyncAppender, etc.

All option values admit variable substitution. The syntax of variable substitution is similar to that of Unix shells. The string between an opening "${" and closing "}" is interpreted as a key. The value of the substituted variable can be defined as a system property or in the configuration file itself. The value of the key is first searched in the defined constants, in the enviroments variables and if not found there, it is then searched in the configuration file being parsed. The corresponding value replaces the ${variableName} sequence.

For example, if $_ENV['home'] env var is set to /home/xyz, then every occurrence of the sequence ${home} will be interpreted as /home/xyz. See LoggerOptionConverter::getSystemProperty() for details.

An example how to use this appender:

  1. require_once dirname(__FILE__).'/../../main/php/Logger.php';
  2. Logger::configure(dirname(__FILE__).'/../resources/appender_dailyfile.properties');
  3.  
  4. $logger Logger::getRootLogger();
  5. $logger->debug("Hello World!");
And the corresponding ini file:

  1. log4php.appender.default = LoggerAppenderDailyFile
  2. log4php.appender.default.layout = LoggerLayoutTTCC
  3. log4php.appender.default.datePattern = Ymd
  4. log4php.appender.default.file = target/examples/daily_%s.log
  5. log4php.rootLogger = DEBUG, default

  • version: $Revision: 883104 $
  • since: 0.5

Located in /configurators/LoggerConfiguratorIni.php (line 65)


	
			
Class Constant Summary
 ADDITIVITY_PREFIX = "log4php.additivity."
 APPENDER_PREFIX = "log4php.appender."
 CATEGORY_PREFIX = "log4php.category."
 FACTORY_PREFIX = "log4php.factory"
 LOGGER_DEBUG_KEY = "log4php.debug"
 LOGGER_FACTORY_KEY = "log4php.loggerFactory"
 LOGGER_PREFIX = "log4php.logger."
 RENDERER_PREFIX = "log4php.renderer."
 ROOT_CATEGORY_PREFIX = "log4php.rootCategory"
 ROOT_LOGGER_PREFIX = "log4php.rootLogger"
 THRESHOLD_PREFIX = "log4php.threshold"
Method Summary
void configure (LoggerHierarchy $hierarchy, [string $url = ''], LoggerHierarchy $repository)
LoggerConfiguratorIni __construct ()
Methods
configure (line 284)

Read configuration from a file.

The function http://www.php.net/parse_ini_file is used to read the file.

The existing configuration is not cleared nor reset. If you require a different behavior, then call Logger::resetConfiguration() method before calling doConfigure(). The configuration file consists of statements in the format key=value. The syntax of different configuration elements are discussed below.

Repository-wide threshold

The repository-wide threshold filters logging requests by level regardless of logger. The syntax is:

 log4php.threshold=[level]

The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a custom level value. A custom level value can be specified in the form level#classname. By default the repository-wide threshold is set to the lowest possible value, namely the level ALL.

Appender configuration

Appender configuration syntax is:

 ; For appender named appenderName, set its class.
 ; Note: The appender name can contain dots.
 log4php.appender.appenderName=name_of_appender_class

 ; Set appender specific options.

 log4php.appender.appenderName.option1=value1
 log4php.appender.appenderName.optionN=valueN
For each named appender you can configure its LoggerLayout. The syntax for configuring an appender's layout is:
 log4php.appender.appenderName.layout=name_of_layout_class
 log4php.appender.appenderName.layout.option1=value1
    ....
 log4php.appender.appenderName.layout.optionN=valueN
Configuring loggers

The syntax for configuring the root logger is:

 log4php.rootLogger=[level], appenderName, appenderName, ...

This syntax means that an optional level can be supplied followed by appender names separated by commas.

The level value can consist of the string values OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL or a custom level value. A custom level value can be specified in the form

level#classname
If a level value is specified, then the root level is set to the corresponding level. If no level value is specified, then the root level remains untouched.

The root logger can be assigned multiple appenders.

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

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

 log4php.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName, ...

The meaning of the optional level value is discussed above in relation to the root logger. In addition however, the value INHERITED can be specified meaning that the named logger should inherit its level from the logger hierarchy.

If no level value is supplied, then the level of the named logger remains untouched.

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

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

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

ObjectRenderers

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

The syntax is:

 log4php.renderer.name_of_rendered_class=name_of_rendering.class
As in,
 log4php.renderer.myFruit=myFruitRenderer

Logger Factories

The usage of custom logger factories is discouraged and no longer documented. Example

An example configuration is given below. Other configuration file examples are given in the tests folder.

 ; Set options for appender named "A1".
 ; Appender "A1" will be a LoggerAppenderSyslog
 log4php.appender.A1=LoggerAppenderSyslog

 ; The syslog daemon resides on www.abc.net
 log4php.appender.A1.ident=log4php-test

 ; A1's layout is a LoggerPatternLayout, 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 level of the log request,
 ; followed by the two rightmost components of the logger 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 LoggerPatternLayout} for further information
 ; on the syntax of the ConversionPattern key.
 log4php.appender.A1.layout=LoggerPatternLayout
 log4php.appender.A1.layout.ConversionPattern="%-4r %-5p %c{2} %M.%L %x - %m%n"

 ; Set options for appender named "A2"
 ; A2 should be a LoggerAppenderRollingFile, 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.
 log4php.appender.A2=LoggerAppenderRollingFile
 log4php.appender.A2.MaxFileSize=10MB
 log4php.appender.A2.MaxBackupIndex=1
 log4php.appender.A2.layout=LoggerLayoutTTCC
 log4php.appender.A2.layout.ContextPrinting="true"
 log4php.appender.A2.layout.DateFormat="%c"

 ; Root logger set to DEBUG using the A2 appender defined above.
 log4php.rootLogger=DEBUG, A2

 ; Logger definitions:
 ; The SECURITY logger inherits is level from root. However, it's output
 ; will go to A1 appender defined above. It's additivity is non-cumulative.
 log4php.logger.SECURITY=INHERIT, A1
 log4php.additivity.SECURITY=false

 ; Only warnings or above will be logged for the logger "SECURITY.access".
 ; Output will go to A1.
 log4php.logger.SECURITY.access=WARN


 ; The logger "class.of.the.day" inherits its level from the
 ; logger hierarchy.    Output will go to the appender's of the root
 ; logger, A2 in this case.
 log4php.logger.class.of.the.day=INHERIT

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

Use the ";" character at the beginning of a line for comments.

  • access: public
void configure (LoggerHierarchy $hierarchy, [string $url = ''], LoggerHierarchy $repository)
  • string $url: The name of the configuration file where the configuration information is stored.
  • LoggerHierarchy $repository: the repository to apply the configuration
  • LoggerHierarchy $hierarchy

Implementation of:
LoggerConfigurator::configure()
Interpret a resource pointed by a url and configure accordingly.
Constructor __construct (line 86)

Constructor

  • access: public
LoggerConfiguratorIni __construct ()
Class Constants
ADDITIVITY_PREFIX = "log4php.additivity." (line 69)
APPENDER_PREFIX = "log4php.appender." (line 72)
CATEGORY_PREFIX = "log4php.category." (line 66)
FACTORY_PREFIX = "log4php.factory" (line 68)
INTERNAL_ROOT_NAME = "root" (line 81)
LOGGER_DEBUG_KEY = "log4php.debug" (line 80)
LOGGER_FACTORY_KEY = "log4php.loggerFactory" (line 79)

Key for specifying the LoggerFactory.

LOGGER_PREFIX = "log4php.logger." (line 67)
RENDERER_PREFIX = "log4php.renderer." (line 73)
ROOT_CATEGORY_PREFIX = "log4php.rootCategory" (line 70)
ROOT_LOGGER_PREFIX = "log4php.rootLogger" (line 71)
THRESHOLD_PREFIX = "log4php.threshold" (line 74)

Documentation generated on Fri, 27 Nov 2009 07:44:49 +0100 by phpDocumentor 1.4.3