PHP Master | Implementing PSR-3 with log4php

Implementing PSR-3 Logging with log4php: A Practical Guide

Key Concepts

This article demonstrates how to implement the PSR-3 logging standard using log4php, a flexible open-source logging framework. PSR-3 provides a common interface for logging libraries, enhancing interoperability and maintainability. log4php's configuration allows routing different log levels (debug, info, error, etc.) to various output destinations (files, email, etc.).

Setting up Dependencies

Before coding, install necessary dependencies. You'll need the PSR-3 interface and the log4php framework. A composer.json file like this simplifies the process:

{
    "require": {
        "psr/log": "dev-master",
        "apache/log4php": "2.3.0"
    }
}

Creating a PSR-3 Compliant Logger

This custom logger class bridges the PSR-3 interface and log4php's functionality, mapping PSR-3 log levels to their log4php equivalents:

<?php
require_once 'vendor/autoload.php';

use Psr\Log\LoggerInterface as PsrLogLoggerInterface;
use Log4php\Logger;

class MyLogger implements PsrLogLoggerInterface
{
    private $logger;

    public function __construct($loggerName = 'main', $configFile = null) {
        Logger::configure($configFile);
        $this->logger = Logger::getLogger($loggerName);
    }

    // ... (PSR-3 log level methods: emergency, alert, critical, error, warning, notice, info, debug) ...

    // Example method (others similar)
    public function error($message, array $context = array()) {
        $this->logger->error($this->interpolate($message, $context));
    }

    // ... (log() method and interpolate() helper function remain unchanged) ...
}

This class handles the eight PSR-3 log levels, translating them to the six log4php levels (mapping multiple PSR-3 levels to log4php's fatal where necessary). The interpolate() function (taken from the PSR-3 example implementation) handles context variables within log messages.

Configuring log4php

log4php uses a default configuration, but you can customize it with XML or PHP. An XML configuration file (config.xml) might look like this to log warnings and above to a file:

<configuration xmlns="http://logging.apache.org/log4php/">
  <appender name="myAppender" class="LoggerAppenderFile">
    <param name="file" value="myLog.log"/>
    <layout class="LoggerLayoutSimple"/>
  </appender>
  <root>
    <level value="WARN"/>
    <appender_ref ref="myAppender"/>
  </root>
</configuration>

To use this configuration, pass the file path to the MyLogger constructor:

$logger = new MyLogger('main', 'config.xml');
$logger->debug('This debug message will be ignored.');
$logger->warn('This warning will be logged to myLog.log');

Conclusion

Integrating PSR-3 with log4php provides a standardized, flexible logging solution. The ability to direct different log levels to specific outputs makes debugging and monitoring applications significantly easier. For further details, consult the log4php Quick Start guide and the PSR-3 standard on GitHub.

Frequently Asked Questions (reformatted for clarity and conciseness):

• PSR-3 Significance: PSR-3 standardizes logging interfaces, allowing easy swapping of logging libraries without code changes.

• Starting with Log4PHP: Configure appenders, layouts, and loggers (XML, PHP, or properties file), then create a logger instance to log messages.

• Installation: Download from Apache Logging Services or use Composer (composer require apache/log4php).

• Configuration: Use XML, PHP, or properties files to define appenders (output destinations), layouts (message formats), and loggers (named logging entities).

• Multiple Appenders: Yes, assign multiple appenders to a logger to send logs to various locations.

• Log Levels: Use debug, info, warn, error, and fatal methods for different severity levels.

• Exception Handling: Use LoggerThrowablePatternConverter to log exception details.

• Framework Integration: Works with PSR-3-compliant frameworks (Laravel, Symfony, etc.).

• Filtering: Use level range, string match, or logger match filters to control output.

• Message Formatting: Use layouts to customize log message formats.

The above is the detailed content of PHP Master | Implementing PSR-3 with log4php. For more information, please follow other related articles on the PHP Chinese website!