From cd68e12b79054716d9d2a4ac042f527247278fbb Mon Sep 17 00:00:00 2001 From: Sergiu Date: Wed, 28 Aug 2024 11:35:05 +0300 Subject: [PATCH] updated README.md --- README.md | 32 +++++++------------------------- 1 file changed, 7 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index ba0a721..a5619cf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,5 @@ # dot-log -> [!IMPORTANT] -> dot-log is a wrapper on top of [laminas/laminas-log](https://github.com/laminas/laminas-log) -> -> ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flaminas%2Flaminas-log%2Fproperties%2Fvalues&query=%24%5B%3F(%40.property_name%3D%3D%22maintenance-mode%22)%5D.value&label=Maintenance%20Mode) - ## dot-log badges ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-log) @@ -29,13 +24,13 @@ * Open the `Dot\Log\ConfigProvider` * In the dependencies section you will see an abstract factory (`LoggerAbstractServiceFactory::class`) * This class responds to "selectors" instead of class names - Instead of requesting the `Laminas\Log\Logger::class` from the container, `dot-log.my_logger` should be requested (or just `my_logger` if using `laminas-log`) + Instead of requesting the `Dot\Log\Logger::class` from the container, `dot-log.my_logger` should be requested ## Configuring the writer(s) Loggers must have at least one writer. -A writer is an object that inherits from `Laminas\Log\Writer\AbstractWriter`. A writer's responsibility is to record log data to a storage backend. (from laminas-log's writer documentation) +A writer is an object that inherits from `Dot\Log\Writer\AbstractWriter`. A writer's responsibility is to record log data to a storage backend. ### Writing to a file (stream) @@ -67,12 +62,7 @@ return [ * The `FileWriter` key is optional, otherwise the writers array would be enumerative instead of associative. * The writer name key is a developer-provided name for that writer, the writer name key is **mandatory**. -The writer priority key is not affecting the errors that are written, it is a way to organize writers, for example: - -1 - FILE -2 - SQL -3 - E-mail -It is the most important to write in the file, the sql or e-mail are more probably fail because the servers can be external and offline, the file is on the same server. +The writer priority key is not affecting the errors that are written, it is a way to organize writers. The writer priority key is optional. @@ -95,7 +85,7 @@ As per PSR-3 document. The log levels are: emergency (0), alert (1), critical (2), error (3), warn (4), notice (5), info (6), debug (7) (in order of priority/importance) -Although the plain Logger in Laminas Log is not fully compatible with PSR-3, it provides a way to log all of these message types. +Although the plain Logger in Dot Log is not fully compatible with PSR-3, it provides a way to log all of these message types. The following example has three file writers using filters: @@ -178,19 +168,17 @@ The filter added on the first writer is equal to not setting a filter, but it wa It was added opposite to the others just to demonstrate the other operator is also an option. -More examples on filters: https://docs.laminas.dev/laminas-log/filters/ - ## Formatting Messages -When using `dot-log` or `laminas-log`, the logged value is not limited to a string. Arrays can be logged as well. +When using `dot-log`, the logged value is not limited to a string. Arrays can be logged as well. For a better readability, these arrays can be serialized. -Laminas Log provides String formatting, XML, JSON and FirePHP formatting. +Dot Log provides String formatting and JSON formatting. The formatter accepts following parameters: -name - the formatter class (it must implement `Laminas\Log\Formatter\FormatterInterface`) +name - the formatter class (it must implement `Dot\Log\Formatter\FormatterInterface`) options - options to pass to the formatter constructor if required The following formats the message as JSON data: @@ -272,10 +260,4 @@ $logger->debug('7 debug'); $logger->log(Logger::NOTICE, 'NOTICE from log()'); ``` -Sources: - -* https://docs.laminas.dev/laminas-log/ -* https://docs.laminas.dev/laminas-log/writers/ -* https://docs.laminas.dev/laminas-log/filters/ - Extracted from [this article](https://www.dotkernel.com/dotkernel/logging-with-dot-log-in-mezzio-and-dotkernel)