Download the PHP package flavienbwk/klogger without Composer
On this page you can find all versions of the php package flavienbwk/klogger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download flavienbwk/klogger
More information about flavienbwk/klogger
Files in flavienbwk/klogger
Package klogger
Short Description A simple logging class.
License
Informations about the package klogger
KLogger: Simple Logging for PHP
A project written by Kenny Katzgrau and Dan Horrigan.
Improved by Flavien Berwick for valid JSON handling.
About
KLogger is an easy-to-use PSR-3 compliant logging class for PHP. It isn't naive about file permissions (which is expected). It was meant to be a class that you could quickly include into a project and have working right away.
If you need a logger that supports PHP < 5.3, see past releases for KLogger versions < 1.0.0.
Installation
Composer
From the Command Line:
Basic Usage
Output
PSR-3 Compliant
KLogger is PSR-3
compliant. This means it implements the Psr\Log\LoggerInterface
.
See Here for the interface definition.
Setting the Log Level Threshold
You can use the Psr\Log\LogLevel
constants to set Log Level Threshold, so that
any messages below that level, will not be logged.
Default Level
The default level is DEBUG
, which means everything will be logged.
Available Levels
Example
Additional Options
KLogger supports additional options via third parameter in the constructor:
Here's the full list:
Option | Default | Description |
---|---|---|
dateFormat | 'Y-m-d G:i:s.u' | The format of the date in the start of the log lone (php formatted) |
extension | 'txt' | The log file extension |
filename | [prefix][date].[extension] | Set the filename for the log file. This overrides the prefix and extention options. |
flushFrequency | false (disabled) |
How many lines to flush the output buffer after |
prefix | 'log_' | The log file prefix |
logFormat | false |
Format of log entries |
appendContext | true |
When false , don't append context to log entries |
Log Formatting
The logFormat
option lets you define what each line should look like and can contain parameters representing the date, message, etc.
When a string is provided, it will be parsed for variables wrapped in braces ({
and }
) and replace them with the appropriate value:
Parameter | Description |
---|---|
date | Current date (uses dateFormat option) |
level | The PSR log level |
level-padding | The whitespace needed to make this log level line up visually with other log levels in the log file |
priority | Integer value for log level (see $logLevels ) |
message | The message being logged |
context | JSON-encoded context |
Tab-separated
Same as default format but separates parts with tabs rather than spaces:
$logFormat = "[{date}]\t[{level}]\t{message}";
Custom variables and static text
Inject custom content into log messages:
$logFormat = "[{date}] [$var] StaticText {message}";
JSON
To output pure JSON, set appendContext
to false
and provide something like the below as the value of the logFormat
option. You can use this :
The output will look like:
{"datetime":"2015-04-16 10:28:41.186728","logLevel":"INFO","message":"Message content","context":"{\"1\":\"foo\",\"2\":\"bar\"}"}
Pretty Formatting with Level Padding
For the obsessive compulsive
$logFormat = "[{date}] [{level}]{level-padding} {message}";
... or ...
$logFormat = "[{date}] [{level}{level-padding}] {message}";
Why use KLogger?
Why not? Just drop it in and go. If it saves you time and does what you need,
go for it! Take a line from the book of our C-code fathers: "build
upon the
work of others".
Who uses KLogger?
Klogger has been used in projects at:
* The University of Iowa
* The University of Laverne
* The New Jersey Institute of Technology
* Middlesex Hospital in NJ
Additionally, it's been used in numerous projects, both commercial and personal.