kodus/chrome-logger
, (*1)
Alternative to the original ChromeLogger for PHP by Craig Campbell, using:, (*2)
-
PSR-3 compliant interface for logging,
-
PSR-7 HTTP message abstraction for the models, and
-
PSR-15 compliant middleware for quick integration.
✨ An alternative to the ChromeLogger extension is also available
and is highly recommended., (*3)
Usage
The logging interface is PSR-3 compliant, so:, (*4)
$logger = new ChromeLogger();
$logger->notice("awesome sauce!");
Note that this will have a header-size limit by default., (*5)
Using a PSR-7 compliant ResponseInterface instance, such as in a middleware stack, you can populate
the Response as follows:, (*6)
$response = $logger->writeToResponse($response);
Or just add an instance of the included PSR-15 ChromeLoggerMiddleware to the top of your middleware stack., (*7)
If you're not using PSR-7, emitting the headers old-school is also possible with ChromeLogger::emitHeader()., (*8)
Logging Table Data
Since PSR-3 does not offer any explicit support for tables, we support tables via the context array., (*9)
For example:, (*10)
$logger->info(
"INFO",
[
"table: SQL Queries" => [
["time" => "10 msec", "sql" => "SELECT * FROM foo"],
["time" => "20 msec", "sql" => "SELECT * FROM baz"],
]
]
);
This works because the "table:" key prefix in the context array is recognized and treated specially., (*11)
Logging a Stack Trace from an Exception
The reserved "exception" key in PSR-3 context values is supported -
the following will result in a stack-trace:, (*12)
try {
something_dumb();
} catch (Exception $e) {
$logger->error("ouch, this looks bad!", ["exception" => $e]);
}
Any PHP values injected via the context array will be serialized for client-side inspection - including complex
object graphs and explicit serialization of problematic types like Exception and DateTime., (*13)
, (*14)
Chrome has a 250KB header size limit
and many popular web-servers (including NGINX and Apache) also have a limit., (*15)
By default, the beginning of the log will be truncated to keep the header size under the limit., (*16)
You can change this limit using the ChromeLogger::setLimit() method - but a better approach is
to enable logging to local files, which will persist in a web-accessible folder for 60 seconds:, (*17)
$logger->usePersistence("/var/www/mysite/webroot/logs", "/logs");
Note that this isn't supported by the ChromeLogger extension - you will need to install the alternative
Server Log Chrome extension instead. (It is backwards
compatible with the header-format of the original ChromeLogger extension, so you can use this as
a drop-in replacement for the original extension.), (*18)
Limitations
We do not currently support log-entry grouping, as supported by the original ChromeLogger for PHP, as
this concept is not supported by PSR-3., (*19)
We do not make use of the reserved '___class_name' key used to color-code objects in ChromeLogger, because this
does not work for nested object graphs - instead, we consistently indicate the object type as type in the console
output, which works well enough, given that object properties are visually qualified with $ prefix in the output.
(Improving this in the future would require changes to the ChromeLogger extension.), (*20)
Why?
The original ChromeLogger for PHP has a static API, and aggressively emits headers, making it unsuitable
for use in a PSR-15 based (or other) middleware stack.
Static classes generally aren't much fun if you enjoy writing testable code., (*21)
This library also implements the PSR-3 LoggerInterface, which makes it easy to substitute this logger
for any other., (*22)
Note that, while we aware of the ChromePHPHandler which comes with the popular logging framework
monolog, kodus/chrome-logger has no external dependencies
beyond the PSR interfaces, and uses ResponseInterface::withHeader() to populate PSR-7 Response objects,
as opposed to making header() calls., (*23)
Wallogit.com
