log4php使用手記

wangccsy發表於2011-07-31
PHP
   log4php是apache的logging下的一個子專案，是log4j在php下的實現。log4j是apache專案下有名的日誌記錄元件，有針對比較流行的語言的實現，log4cxx，log4j，log4net，log4php等等。
   官方對log4php的介紹如下。

Apache log4php™ is a versatile logging framework for PHP.

Feature highlights:

  • Configuration through XML, properties or PHP files
  • Various logging destinations, including:
    • Console (stdout, stderr)
    • Files (including daily and rolling files)
    • Email
    • Databases
    • Sockets
    • Syslog
  • Several built-in log message formats, including:
    • HTML
    • XML
    • User defined pattern
  • Nested (NDC) and Mapped (MDC) Diagnostic Contexts.

  2009年log4php版推出2.0.0版本後，很長一段時間沒有更新，最近更新到了2.1.0版本。下載地址在http://logging.apache.com。2.1.0版本支援了對php的pear包的支援，可以將log4php功能整合到pear包中。

   我們下載的包解壓，將srcmain下的php目錄拷貝到web文件目錄，並重新命名為log4php。

   寫一個簡單的測試例子： 

  1. ?php
  2. include(`log4php/Logger.php`);
  4. $logger = Logger::getLogger(“main”);
  5. $logger–>info(“foo”);
  6. $logger–>warn(“bar”);
  7. ?>

    在控制檯（windows下用cmd命令執行）會看到如下的輸出：

[quote]07/31/11 08:26:12,043 [496] INFO main – foo
07/31/11 08:26:12,047 [496] WARN main – bar[/quote]

   注意：你用瀏覽器開啟，是看不到輸出的，因為log4php的預設配置輸出是到控制檯。

   通過配置檔案配置日誌的輸出，log4php.xml如下：

  1. ?xml version=“1.0” encoding=“UTF-8”?>
  2. log4php:configuration xmlns:log4php=“http://logging.apache.org/log4php/”>
  3.     appender name=“myAppender” class=“LoggerAppenderFile”> !– 1 —>
  4.         param name=“file” value=“myLog.log”/> !– 2 —>
  5.     /appender>
  6.     root>
  7.         level value=“WARN” /> !– 3 —>
  8.         appender_ref ref=“myAppender” /> !– 4 —>
  9.     /root>
  10. /log4php:configuration>

配置檔案說明：

1、建立一個LoggerAppenderFile，用於日誌檔案輸出。

2、檔案引數，用於日誌輸出的檔案配置。

3、設定root的級別為WARN，低於WARN的日誌不會輸出。

4、root的日誌輸出連線到myAppender上。

測試程式如下：

  1. ?php
  2.     // Insert the path where you unpacked log4php
  4.     include(`log4php/Logger.php`);
  6.     // Tell log4php to use our configuration file.
  8.     Logger::configure(`log4php.xml`);
  10.     // Fetch a logger, it will inherit settings from the root logger
  12.     $log = Logger::getLogger(`myLogger`);
  14.     // Start logging
  16.     $log–>trace(“My first message.”); // Not logged because TRACE
  18.     $log–>debug(“My second message.”); // Not logged because DEBUG
  20.     $log–>info(“My third message.”); // Not logged because INFO
  22.     $log–>warn(“My fourth message.”); // Logged because WARN >= WARN
  24.     $log–>error(“My fifth message.”); // Logged because ERROR >= WARN
  26.     $log–>fatal(“My sixth message.”); // Logged because FATAL >= WARN
  28. ?>

我們看到myLog.log檔案中輸出如下資訊：

WARN – My fourth message.
ERROR – My fifth message.
FATAL – My sixth message.

比WARN級別低的日誌沒有輸出。

更高階一點的配置：

  1. ?xml version=“1.0” encoding=“UTF-8”?>
  2. log4php:configuration xmlns:log4php=“http://logging.apache.org/log4php/”>
  3.     
  4.     appender name=“myConsoleAppender” class=“LoggerAppenderConsole” />
  5.     
  6.     appender name=“myFileAppender” class=“LoggerAppenderFile”>
  7.                 layout class=“LoggerLayoutTTCC” />
  8.         param name=“file” value=“myLog.log” />
  9.     /appender>
  11.     logger name=“Foo”>
  12.         appender_ref ref=“myFileAppender” />
  13.     /logger>
  14.     
  15.     root>
  16.         level value=“DEBUG” />
  17.         appender_ref ref=“myConsoleAppender” />
  18.     /root>
  19. /log4php:configuration>

在這個配置檔案中，

named loggers

using layouts

best practices in object-oriented programming

通過測試檔案如下：

  1. ?php
  2.     include(`log4php/Logger.php`);
  4. Logger::configure(`D:log4php.xml`);
  6. /**
  7.  * This is a classic pattern: using one logger object per class.
  8.  */
  9. class Foo
  10. {
  11.     /** Holds the Logger. */
  12.     private $log;
  14.     /** Logger is instantiated in the constructor. */
  15.     public function __construct()
  16.     {
  17.         // The __CLASS__ constant holds the class name, in our case “Foo”.
  19.         // Therefore this creates a logger named “Foo” (which we configured in the config file)
  21.         $this–>log = Logger::getLogger(__CLASS__);
  22.     }
  24.     /** Logger can be used from any member method. */
  25.     public function go()
  26.     {
  27.         $this–>log–>info(“We have liftoff.”);
  28.     }
  29. }
  31. $foo = new Foo();
  32. $foo–>go();
  33. ?>

下面的資訊將會輸出在控制檯：

INFO – We have liftoff.

下面的資訊將輸出在myLog.log檔案中：

01/06/11 18:43:39,545 [5428] INFO Foo – We have liftoff.

注意檔案輸出的不同，因為在檔案appender中使用了LoggerLayoutTTCC這個Layout。

PS：在Linux下要注意輸出日誌的目錄，apache使用者有許可權寫入。

還可以採用properties的形式配置，或者php檔案。更多的資料可以參照apache官方網站。http://logging.apache.org/log4php/docs/introduction.html


相關文章