katzgrau / klogger
简单的日志类
Requires
- php: >=5.3
- psr/log: ^1.0.0
Requires (Dev)
- phpunit/phpunit: ^6.0.0
This package is not auto-updated.
Last update: 2024-09-21 07:09:07 UTC
README
该项目由Kenny Katzgrau和Dan Horrigan编写。
关于
KLogger是一个易于使用的PHP日志类,遵循PSR-3规范。它不关心文件权限(这是预期的)。它的目的是快速集成到项目中并立即使用。
如果您需要一个支持PHP < 5.3的日志记录器,请查看KLogger的旧版本。
安装
Composer
从命令行
composer require katzgrau/klogger:dev-master
在您的composer.json
文件中
{ "require": { "katzgrau/klogger": "dev-master" } }
基本用法
<?php require 'vendor/autoload.php'; $users = [ [ 'name' => 'Kenny Katzgrau', 'username' => 'katzgrau', ], [ 'name' => 'Dan Horrigan', 'username' => 'dhrrgn', ], ]; $logger = new Katzgrau\KLogger\Logger(__DIR__.'/logs'); $logger->info('Returned a million search results'); $logger->error('Oh dear.'); $logger->debug('Got these users from the Database.', $users);
输出
[2014-03-20 3:35:43.762437] [INFO] Returned a million search results
[2014-03-20 3:35:43.762578] [ERROR] Oh dear.
[2014-03-20 3:35:43.762795] [DEBUG] Got these users from the Database.
0: array(
'name' => 'Kenny Katzgrau',
'username' => 'katzgrau',
)
1: array(
'name' => 'Dan Horrigan',
'username' => 'dhrrgn',
)
PSR-3兼容
KLogger遵循PSR-3规范。这意味着它实现了Psr\Log\LoggerInterface
。
设置日志级别阈值
您可以使用Psr\Log\LogLevel
常量来设置日志级别阈值,这样低于该级别的任何消息都不会被记录。
默认级别
默认级别是DEBUG
,这意味着所有内容都将被记录。
可用级别
<?php use Psr\Log\LogLevel; // These are in order of highest priority to lowest. LogLevel::EMERGENCY; LogLevel::ALERT; LogLevel::CRITICAL; LogLevel::ERROR; LogLevel::WARNING; LogLevel::NOTICE; LogLevel::INFO; LogLevel::DEBUG;
示例
<?php // The $logger = new Katzgrau\KLogger\Logger('/var/log/', Psr\Log\LogLevel::WARNING); $logger->error('Uh Oh!'); // Will be logged $logger->info('Something Happened Here'); // Will be NOT logged
附加选项
KLogger通过构造函数中的第三个参数支持附加选项
<?php // Example $logger = new Katzgrau\KLogger\Logger('/var/log/', Psr\Log\LogLevel::WARNING, array ( 'extension' => 'log', // changes the log file extension ));
以下是完整列表
日志格式化
logFormat
选项允许您定义每行应该是什么样子,并可以包含代表日期、消息等的参数。
当提供一个字符串时,它将被解析以查找大括号({
和}
)内的变量,并用适当的值替换它们
制表符分隔
与默认格式相同,但用制表符而不是空格分隔部分
$logFormat = "[{date}]\t[{level}]\t{message}";
自定义变量和静态文本
将自定义内容注入日志消息中
$logFormat = "[{date}] [$var] StaticText {message}";
JSON
要输出纯JSON,将appendContext
设置为false
,并将以下内容作为logFormat
选项的值提供
$logFormat = json_encode([
'datetime' => '{date}',
'logLevel' => '{level}',
'message' => '{message}',
'context' => '{context}',
]);
输出将如下所示
{"datetime":"2015-04-16 10:28:41.186728","logLevel":"INFO","message":"Message content","context":"{"1":"foo","2":"bar"}"}
具有级别填充的美观格式化
对于强迫症者
$logFormat = "[{date}] [{level}]{level-padding} {message}";
... 或者 ...
$logFormat = "[{date}] [{level}{level-padding}] {message}";
为什么使用KLogger?
为什么不呢?直接放入并使用。如果它能节省您的时间并满足您的需求,那就去用它吧!引用我们C语言之父的书中的一句话:“建立在他人之上
”。
谁使用KLogger?
Klogger已在以下项目中使用
* The University of Iowa
* The University of Laverne
* The New Jersey Institute of Technology
* Middlesex Hospital in NJ
此外,它已在众多项目中使用,包括商业和个人项目。
特别感谢
特别感谢所有贡献者
许可
MIT许可
版权(c)2008-2015 Kenny Katzgrau katzgrau@gmail.com
在此前提下,免费授予任何获得此软件及其相关文档文件(以下简称“软件”)副本的个人在此软件上不受限制地处理的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本,并允许获得软件的个人这样做,但受以下条件约束
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于对适销性、特定用途适用性和非侵权的保证。在任何情况下,作者或版权所有者不应对任何索赔、损害或其他责任负责,无论这些责任是因合同行为、侵权行为或其他原因产生,与软件或软件的使用或其他使用相关。