LoggerAppenderConsole writes logging events to the stdout (php://stdout) or
- the stderr (php://stderr) stream, the former being the default target.
LoggerAppenderConsole writes logging events to the php://stdout or
+ the php://stderr stream, the former being the default target.
The following options are available:
@@ -44,7 +44,7 @@Apache log4php can be configured either programatically or with a file containing the configuration parameters in one of the supported formats.
-The configuration should be provided by calling Logger::configure(...) method before any logging
- is done. Otherwise, the default configuration will be used.
If no configuration
+The configuration should be provided by calling Logger::configure() method before any logging
+ is done. Otherwise, the default configuration will be used.
XML is the most common configuration format, and it is the most prominently featured in the + documentation and examples.
+ +Configuration is stored in a PHP array. This is the format used internally by log4php and other - formats are converted to a PHP array before being used. Because of this, the PHP format should be - used when performance is important.
+Configuration can also be stored in a PHP array. This is the format used internally by log4php. Other + formats are converted to a PHP array before being used. Because of this, the PHP configuration format + should be used when performance is important.
It is possible to pass an configuration array directly to Logger::configure().
Logger::configure('config.php');
- Hint: to translate a XML or properties configuration file to PHP, run the following code:
+ +The properties configuration format is a legacy method of configuring log4php. It was inherited from
+ Apache log4j and uses the same format. The only
+ difference is that lines begin with log4php instead of log4j.
Logger::configure('config.php');
+ The properites configuration format does not support filters.
+The following is a high level overview of all options provided by this format:
- + +
+# Appender named "default"
+log4php.appender.default = LoggerAppenderEcho
+log4php.appender.default.layout = LoggerLayoutTTCC
+
+# Appender named "file"
+log4php.appender.file = LoggerAppenderDailyFile
+log4php.appender.file.layout = LoggerLayoutPattern
+log4php.appender.file.layout.conversionPattern = %d{ISO8601} [%p] %c: %m (at %F line %L)%n
+log4php.appender.file.datePattern = Ymd
+log4php.appender.file.file = target/examples/daily_%s.log
+log4php.appender.file.threshold = warn
+
+# Root logger, linked to "default" appender
+log4php.rootLogger = DEBUG, default
+
+# Logger named "foo", linked to "default" appender
+log4php.logger.foo = warn, default
+
+# Logger named "foo.bar", linked to "file" appender
+log4php.logger.foo.bar = debug, file
+log4php.additivity.foo.bar = true
+
+# Logger named "foo.bar.baz", linked to both "file" and "default" appenders
+log4php.logger.foo.bar.baz = trace, default, file
+log4php.additivity.foo.bar.baz = false
+
+# Renderers for Fruit and Beer classes
+log4php.renderer.Fruit = FruitRenderer
+log4php.renderer.Beer = BeerRenderer
+
+# Setting base threshold
+log4php.threshold = debug
+
If no configuration is provided before the initial logging request is issued, log4php will configure
+ using the default configuration. This consists of a single LoggerAppenderEcho appender,
+ using LoggerLayoutTTCC, attached to the root logger and set to the DEBUG level.
The default configuration in PHP format is:
+ +
+array(
+ 'rootLogger' => array(
+ 'appenders' => array('default'),
+ ),
+ 'appenders' => array(
+ 'default' => array(
+ 'class' => 'LoggerAppenderConsole',
+ 'layout' => array(
+ 'class' => 'LoggerLayoutSimple'
+ )
+ )
+ )
+)
+
- It is possible to configure log4php fully programmatically.
+Filtering is a mechanism which allows the user to configure more precisely which logging events will be + logged by an appender, and which will be ignored.
+ +Multiple filters can be defined on any appender; they will form a filter chain. When a logging event is + passed onto an appender, the event will first pass through the filter chain. Each filter in the chain will + examine the logging event and make a decision to either:
+ +Filters are configurable in the XML and PHP configuration format. They cannot be configured using + the properties configuration format.
+ +Like appenders and layouts, depending on the class used, filters may have configurable parameters + which determine their behaviour.
+ +Here is an XML configuration example:
+ +++ ++ ++ + + + ++ + + ++ + +]]>+ +
And the same configuration in PHP format:
+ + array(
+ 'default' => array(
+ 'class' => 'LoggerAppenderEcho'
+ 'layout' => array(
+ 'class' => 'LoggerLayoutSimple'
+ ),
+ 'filters' => array(
+ array(
+ 'class' => 'LoggerFilterStringMatch',
+ 'params' => array(
+ 'stringToMatch' => 'interesting',
+ 'acceptOnMatch' => true,
+ )
+ ),
+ array(
+ 'class' => 'LoggerFilterLevelRange',
+ 'params' => array(
+ 'levelMin' => 'debug',
+ 'levelMax' => 'error',
+ )
+ )
+ )
+ )
+ ),
+ 'rootLogger' => array(
+ 'appenders' => array('default'),
+ )
+)
+]]>
+
+
+ In this example, there are two filters defined for the default appender.
+ +The first filter LoggerFilterStringMatch searches for the string "interesting" in the
+ logging event's message. If the string is found, the filter will ACCEPT the logging event, and the
+ event will be logged. If the string is not found, the filter will remain NEUTRAL, and the event will be
+ passed on to the next filter.
The second filter LoggerFilterLevelRange ACCEPTS all events which have a level between
+ DEBUG and ERROR (in other words, levels DEBUG, INFO, WARN and ERROR). It DENIES all other events.
Therefore, this filter configuration will log events which which have a level between DEBUG and + ERROR, except of theose which have the string "interesting" in the message. Those will be logged + regardless of their level.
+ +The following filters are available in log4php:
+ +| Name | +Destination | +
|---|---|
| LoggerFilterDenyAll | +Denies all logging events. | +
| LoggerFilterLevelMatch | +Filters based on logging event level. | +
| LoggerFilterLevelRange | +Filters based on logging event level range. | +
| LoggerFilterStringMatch | +Filters by searching for a string in the logging event message. | +
This filters simply denies all logging events. It has no configurable parameters.
+This filter either accepts the specified logger level or denies it.
+ +| Option | +Type | +Required | +Default | +Description | +
|---|---|---|---|---|
| levelToMatch | +LoggerLevel | +Yes | +- | +The level to match | +
| acceptOnMatch | +boolean | +No | +true | +If true, the matching log level is accepted, denied otherwise. | +
The following filter configuration will deny all logging events with level DEBUG. It will remain + neutral for others.
+ ++ + + +]]>+ +
This filter accepts or denies logging events if their log level is within the specified range.
+ +| Option | +Type | +Required | +Default | +Description | +
|---|---|---|---|---|
| levelMin | +LoggerLevel | +Yes | +- | +The minimum level to log. If set, levels lower than this will be denied. | +
| levelMax | +LoggerLevel | +Yes | +- | +The maximum level to log. If set, levels higher than this will be denied. | +
| acceptOnMatch | +boolean | +No | +true | +If true, the matching log level is accepted, denied otherwise. | +
The following filter configuration denies levels greater than WARN.
+ ++ + + +]]>+ +
This filter allows or denies logging events if their message contains a given string.
+ +| Option | +Type | +Required | +Default | +Description | +
|---|---|---|---|---|
| stringToMatch | +LoggerLevel | +Yes | +- | +The level to match | +
| levelMax | +LoggerLevel | +Yes | +- | +The level to match | +
| acceptOnMatch | +boolean | +No | +true | +If true, the matching log level is accepted, denied otherwise. | +
The following filter configuration denies events which contain the string "not-interesting" in + their message.
+ ++ + + +]]>+ +
Download the latest source package from the download page and unpack it.
+ +The package directory structure is as follows:
+ ++ââââapidocs - API generated documentation +ââââsrc + ââââassembly - Maven assembly configuration + ââââchanges - The change log + ââââexamples - Various usage examples + ââââmain + â ââââphp - The main source code + ââââsite - Web site source + ââââtest - Unit tests ++
Most users will primarily be interested in the source code which is located in
+ /src/main/php. The contents of this directory may be copied to a directory within your
+ project for easier access.
Apache log4php has it's own PEAR channel.
+ +To install from the PEAR channel, execute the following commands:
+ ++pear channel-discover pear.apache.org/log4php +pear install log4php/Apache_log4php ++ +
Information about your use of this web site is collected using server access logs and a tracking cookie. + The collected information consists of the following:
+ +Part of this information is gathered using a tracking cookie set by the + Google Analytics service + and handled by Google as described in their + privacy policy. + See your browser documentation for instructions on how to disable the cookie if you prefer not to share + this data with Google.
+ +We use the gathered information to help us make our site more useful to visitors and to better understand how + and when our site is used. We do not track or collect personally identifiable information or associate gathered + data with any personally identifying information from other sources.
+ +By using this web site, you consent to the collection of this data in the manner and for the purpose described + above.
+This example covers named loggers, layouts and best practices in object-oriented programming.
+ +Create a configuration file named log4php.xml with the following content:
++ ++ + +]]>+ + + + ++ + + + ++ + ++ +
The configuration defines two appenders: one writes to the console, and the other to a file.
+ +The
+ console appender doesn't have a layout defined, so it will revert to default layout
+ (LoggerLayoutSimple). The
+ file appender uses a different layout
+ (LoggerLayoutTTCC)
+ which will result in different formatting of the logging
+ events.
The console appender is linked to the root logger. The file appender is linked to the logger named
+ Foo, however Foo also inherits appenders from the root logger (in this case
+ the console appender). This means that logging events sent to the Foo logger will be
+ logged both to the console and the file.
Consider the following code snippet:
+ +log = Logger::getLogger(__CLASS__);
+ }
+
+ /** Logger can be used from any member method. */
+ public function go()
+ {
+ $this->log->info("We have liftoff.");
+ }
+}
+
+$foo = new Foo();
+$foo->go();
+]]>
+
+ This produces the following output in the console:
+INFO - We have liftoff.+ +
And the following in the log file:
+01/06/11 18:43:39,545 [5428] INFO Foo - We have liftoff.+
Note the different layout, this is because LoggerLayoutTTCC was used as layout for the file appender.