log4php的使用方法与详细配置
log4php的使用
首先引入logger.php文件。log4php可以通过引入logger.php来完成自动加载的过程。文件位置如下:
日志记录器自身没有定义日志的输出目的地和格式,所以我们通常需要引入log4php后要先引入配置文件(下面会详细介绍)。日志记录器是一个组件,我们通过日志记录器来记录日志信息。引入配置文件后通过getLogger获得一个将日志记录器实体。然后可以通过打印方法打印出日志信息。打印方法通常包括info、warn、error、debug等。
include('Logger.php');
Logger::Configure(COMMON_PATH . 'Conf/log.php');//引入配置文件
$logger = Logger::getLogger("main"); //生成日志实例
$logger->info("This is an informational message."); //在规定好的输出目的地用规定好的输出格式显示信息消息
log4php配置
log4php配置文件支持 XML、PHP、Properties (INI)等格式。同样支持可编程配置,即通过函数来改变配置。
class MyConfigurator implements LoggerConfigurator {
public function configure(LoggerHierarchy $hierarchy, $input = null) {
// Create an appender which logs to file
$appFile = new LoggerAppenderFile('foo');
$appFile->setFile('D:/Temp/log.txt');
$appFile->setAppend(true);
$appFile->setThreshold('all');
$appFile->activateOptions();
// Use a different layout for the next appender
$layout = new LoggerLayoutPattern();
$layout->setConversionPattern("%date %logger %msg%newline");
$layout->activateOptions();
// Create an appender which echoes log events, using a custom layout
// and with the threshold set to INFO
$appEcho = new LoggerAppenderEcho('bar');
$appEcho->setLayout($layout);
$appEcho->setThreshold('info');
$appEcho->activateOptions();
// Add both appenders to the root logger
$root = $hierarchy->getRootLogger();
$root->addAppender($appFile);
$root->addAppender($appEcho);
}
}
log4php 官方文档:http://logging.apache.org/log4php/
Logger::Configure(COMMON_PATH . 'Conf/log.php');
项目中由这行代码引入配置。配置中一般包含以下内容:
1.日志信息的优先级;2.日志信息的输出目的地; 3.日志信息的输出格式。
一.log4php 日志信息优先级
日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG。
以下是常用四种等级的用法:
DEBUG Level指出细粒度信息事件对调试应用程序是非常有帮助的。
INFO level表明 消息在粗粒度级别上突出强调应用程序的运行过程。
WARN level表明会出现潜在错误的情形。
ERROR level指出虽然发生错误事件,但仍然不影响系统的继续运行。
程序只能显示比当前设置的等级优先级级更低的信息。例如当前程序设置level为DEBUG,那么就是说程序中所有信息都能显示出来。如果当前程序level为info,那么只有info,warn,error三中日志信息可以展示。
return array(
'rootLogger' => array(
'appenders' => array(
'myConsoleAppender',
),
'level' => 'DEBUG'
),
)
二.输出地址配置
和优先级一样,输出地址同样可以在配置文件中作出配置,并且可以根据不同的日志类别设置不同的输出目的地。例:
'loginFileAppender' => [
'class' => 'LoggerAppenderDailyFile',
'layout' => [
'class' => 'LoggerLayoutPattern',
'params' => [
'conversionPattern' => '%date [%logger] %message%newline',
],
],
'params' => [
'file' => './log/login/login_%s.log',
'datePattern' => 'Y_m_d',
]
],
log4php支持12种输出目的地,分别为:
- LoggerAppenderConsole 以php://stdout为输出目的地
- LoggerAppenderFile 以文件为输出目的地
- LoggerAppenderDailyFile 以文件为目的地,每日输出一个文件
- LoggerAppenderDb 以数据库为输出目的地
- LoggerAppenderEcho 在执行文件尾输出
- LoggerAppenderMail 以邮件为输出地
- LoggerAppenderMailEvent 以邮件为输出地, 为事件触发
- LoggerAppenderNull 不输出任何信息
- LoggerAppenderPhp LoggerAppenderPhp 输出至PHP错误信息,将各类日志等级信息转化为php标准信息
- LoggerAppenderRollingFile 以xxx.log.1, xxx.log.2的形式输出
- LoggerAppenderSocket 以socket方式输出
- LoggerAppenderSyslog 以系统日志为目的地输出,使用php中的syslog()函数进行记录
代码中便是规定了以每日输出一个文件作为输出目的地,用来记录登录类型的日志信息。
三.日志文件输出格式
它作为输出目的地的一个属性存在,log4php上包含5种不同的输出方式,分别为:
- LoggerLayoutHtml 以html格式输出调试信息
- LoggerLayoutSimple 简单的以 "等级信息 - 日志信息"的格式显示
- LoggerLayoutTTCC 以"月/日/年 时间[进程] 等级信息 日志名称 - 调试信息"的格式来显示
- LoggerLayoutPattern 以模式表达式作为输出格式来显示(这个模式可以自定义输出格式)
- LoggerXmlLayout//以xml的模式来输出
LoggerLayoutPattern 模式的一些格式参数
LoggerLayoutPattern为我们提供了自定义日志信息格式的方法,项目中也常常使用该模式来自定义日志信息。在实际使用中,我们通过配置conversionPattern参数来定义模式。而参数变量中通常使用一些log4php提供的转换说明符来配置。
例如:
'conversionPattern' => '%date [%logger] %message%newline'
格式为: yyyy-mm-ddThh:mm:ss+08:00.[日志类型].日志内容.换行。
常用的转换说明符有:
- %logger(%lo,%c)请求日志的日志记录器的名称。
- %data($d)时间。默认为ISO8601格式。可以通过%data{(格式)}改变格式。
- %location(%l)调用者的位置信息
- %message(%m %msg)日志的内容
- %n(%newline)换行
- %level(%p)当前日志事件的优先级
关于转换说明符的完整说明:http://logging.apache.org/log4php/docs/layouts/pattern.html