From 5b0c609863f361e36a606e625c98f68e893f599b Mon Sep 17 00:00:00 2001 From: bidi Date: Thu, 4 Apr 2024 14:46:34 +0300 Subject: [PATCH] updated documentation --- docs/book/v3/adding-config-provider.md | 5 +++-- docs/book/v3/configuring-writer.md | 9 ++++++--- docs/book/v3/example-with-formatter.md | 7 +++---- docs/book/v3/filtering-log-messages.md | 7 ++----- docs/book/v3/formatting-messages.md | 7 ++----- docs/book/v3/grouping-log-files-by-date.md | 6 ++++-- docs/book/v3/usage.md | 6 ++++-- 7 files changed, 24 insertions(+), 23 deletions(-) diff --git a/docs/book/v3/adding-config-provider.md b/docs/book/v3/adding-config-provider.md index 8c73448..b3150eb 100644 --- a/docs/book/v3/adding-config-provider.md +++ b/docs/book/v3/adding-config-provider.md @@ -1,4 +1,5 @@ -## Adding The Config Provider +# Adding The Config Provider + * Enter config/config.php * If there is no entry for the config provider below, add it: `\Dot\Log\ConfigProvider::class` @@ -6,4 +7,4 @@ * Open the `Dot\Log\ConfigProvider` * In the dependencies section you will see an absctract 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) \ No newline at end of file + 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) diff --git a/docs/book/v3/configuring-writer.md b/docs/book/v3/configuring-writer.md index 68f2bee..4a05862 100644 --- a/docs/book/v3/configuring-writer.md +++ b/docs/book/v3/configuring-writer.md @@ -1,13 +1,16 @@ -## Configuring the writer(s) +# 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) ### Writing to a file (stream) + It is possible separate logs into multiple files using writers and filters. For example *warnings.log*, *errors.log*, *all_messages.log*. The following is the simplest example to write all log messages to `/log/dk.log` + ```php return [ 'dot_log' => [ @@ -27,10 +30,10 @@ 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 @@ -40,4 +43,4 @@ It is the most important to write in the file, the sql or e-mail are more probab The writer priority key is optional. -To write into a file the key stream must be present in the writer options array. This is required only if writing into streams/files. \ No newline at end of file +To write into a file the key stream must be present in the writer options array. This is required only if writing into streams/files. diff --git a/docs/book/v3/example-with-formatter.md b/docs/book/v3/example-with-formatter.md index d301f84..58caf68 100644 --- a/docs/book/v3/example-with-formatter.md +++ b/docs/book/v3/example-with-formatter.md @@ -1,4 +1,4 @@ -### Example with formatter +# Example with formatter * The log is used through dot-log * The logger name is my_logger @@ -8,8 +8,6 @@ ```php [ 'loggers' => [ @@ -50,6 +48,7 @@ The messages are written to see which logs are written and which are not written use Laminas\Log\Logger; ``` ... + ```php $logger = $container->get('dot-log.my_logger'); @@ -63,4 +62,4 @@ $logger->notice('5 NOTICE'); $logger->info('6 INF'); $logger->debug('7 debug'); $logger->log(Logger::NOTICE, 'NOTICE from log()'); -``` \ No newline at end of file +``` diff --git a/docs/book/v3/filtering-log-messages.md b/docs/book/v3/filtering-log-messages.md index 8913967..c6860bf 100644 --- a/docs/book/v3/filtering-log-messages.md +++ b/docs/book/v3/filtering-log-messages.md @@ -1,4 +1,4 @@ -## Filtering log messages +# Filtering log messages As per PSR-3 document. @@ -6,7 +6,6 @@ The log levels are: emergency (0), alert (1), critical (2), error (3), warn (4), 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. - The following example has three file writers using filters: * First Example: `FileWriter` - All messages are logged in `/log/dk.log` * Second Example: `OnlyWarningsWriter` - Only warnings are logged in `/log/warnings.log` @@ -87,6 +86,4 @@ 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/ \ No newline at end of file +More examples on filters: https://docs.laminas.dev/laminas-log/filters/ diff --git a/docs/book/v3/formatting-messages.md b/docs/book/v3/formatting-messages.md index c0e2c6c..706877c 100644 --- a/docs/book/v3/formatting-messages.md +++ b/docs/book/v3/formatting-messages.md @@ -1,4 +1,4 @@ -## Formatting Messages +# Formatting Messages When using `dot-log` or `laminas-log`, the logged value is not limited to a string. Arrays can be logged as well. @@ -6,16 +6,13 @@ For a better readability, these arrays can be serialized. Laminas Log provides String formatting, XML, JSON and FirePHP formatting. - - The formatter accepts following parameters: name - the formatter class (it must implement Laminas\Log\Formatter\FormatterInterface) options - options to pass to the formatter constructor if required - The following formats the message as JSON data: 'formatter' => [ 'name' => \Laminas\Log\Formatter\Json::class, -], \ No newline at end of file +], diff --git a/docs/book/v3/grouping-log-files-by-date.md b/docs/book/v3/grouping-log-files-by-date.md index 17480af..6cf70b4 100644 --- a/docs/book/v3/grouping-log-files-by-date.md +++ b/docs/book/v3/grouping-log-files-by-date.md @@ -1,8 +1,10 @@ -## Grouping log files by date +# Grouping log files by date + By default, logs will be written to the same file: `log/dk.log`. Optionally, you can use date format specifiers wrapped between curly braces in your FileWriter's `stream` option, automatically grouping your logs by day, week, month, year etc. Examples: + * `log/dk-{Y}-{m}-{d}.log` will write every day to a different file (eg: log/dk-2021-01-01.log) * `log/dk-{Y}-{W}.log` will write every week to a different file (eg: log/dk-2021-10.log) -The full list of format specifiers is available [here](https://www.php.net/manual/en/datetime.format.php). \ No newline at end of file +The full list of format specifiers is available [here](https://www.php.net/manual/en/datetime.format.php). diff --git a/docs/book/v3/usage.md b/docs/book/v3/usage.md index f6c3a28..b297bf1 100644 --- a/docs/book/v3/usage.md +++ b/docs/book/v3/usage.md @@ -1,4 +1,5 @@ -## Usage +# Usage + Basic usage of the logger is illustraded below. The messages are written to see which logs are written and which are not written. @@ -6,6 +7,7 @@ The messages are written to see which logs are written and which are not written use Laminas\Log\Logger; ``` ... + ```php $logger = $container->get('dot-log.my_logger'); @@ -19,4 +21,4 @@ $logger->notice('5 NOTICE'); $logger->info('6 INF'); $logger->debug('7 debug'); $logger->log(Logger::NOTICE, 'NOTICE from log()'); -``` \ No newline at end of file +```