Download the PHP package levacic/monolog-exception-with-context-processor without Composer
On this page you can find all versions of the php package levacic/monolog-exception-with-context-processor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download levacic/monolog-exception-with-context-processor
More information about levacic/monolog-exception-with-context-processor
Files in levacic/monolog-exception-with-context-processor
Package monolog-exception-with-context-processor
Short Description A Monolog processor to automatically extract context from suitable exceptions
License MIT
Homepage https://github.com/levacic/monolog-exception-with-context-processor
Informations about the package monolog-exception-with-context-processor
Exception-with-context processor for Monolog
This package processes exceptions passed via the log record's context
and extracts the exception chain with context into a key within the log record's extra
section.
The chain includes all chained exceptions, but the context is only extracted from those that implement the ExceptionWithContext interface.
Requirements
- PHP >= 7.0
Installation
Usage
Configuration
The following should be done wherever you normally configure your logging infrastructure.
That's all it takes to setup the processor.
Why would I do this?
This processor is pretty useless on its own. The main benefit of using it is when also using the ExceptionWithContext interface to attach additional context to your exceptions.
This processor checks whether the log record context has an exception
key set, and if its value is an exception (or rather, a Throwable
). If it is, it will traverse that exception's chain (using $exception->getPrevious()
), and extract the context for each of the exceptions in the chain that implement ExceptionWithContext
.
The whole chain of exceptions with their contexts will be placed into an exception_chain_with_context
key in the extra
part of the log record. Each exception will have an exception
key which is the class name of the exception, and a context
key which is either the context returned by the exception if it implements ExceptionWithContext
, or null
otherwise.
Example
Assume the following exception class:
Now assume you have a $logger
which is a Monolog\Logger
instance configured with this processor.
This processor would add a new key in the extra
part of the log record which looks like this:
This basically allows you to have the context of each exception in the chain logged wherever you log stuff. This is useful even if you just log stuff in files (although the readability of such logs for PHP applications is generally questionable), but it's really helpful when logging into external systems capable of formatting and nicely displaying the additional information passed with logged messages, or performing searches/filtering/aggregation across your log data.
License
This package is open-source software licensed under the [MIT license][LICENSE].
All versions of monolog-exception-with-context-processor with dependencies
levacic/exception-with-context Version ^1.0
monolog/monolog Version ^2.2