adjust documentation

This commit is contained in:
Daniel Seifert 2025-02-12 11:10:21 +01:00
parent 6338b58570
commit b867640e8e
2 changed files with 33 additions and 3 deletions

View File

@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased](https://git.d3data.de/D3Public/loggerFactory/compare/1.0.0...rel_1.x) ## [Unreleased](https://git.d3data.de/D3Public/loggerFactory/compare/1.1.0...rel_1.x)
## [1.1.0](https://git.d3data.de/D3Public/loggerFactory/compare/1.0.0...1.1.0) - 2025-02-12
### Added
- can apply preconfigured processors
- UidProcessor
- SensitiveFilterProcessor
### Removed
- Monolog v3 support (different object structure)
## [1.0.0](https://git.d3data.de/D3Public/loggerFactory/releases/tag/1.0.0) - 2025-02-06 ## [1.0.0](https://git.d3data.de/D3Public/loggerFactory/releases/tag/1.0.0) - 2025-02-06
### Added ### Added

View File

@ -38,11 +38,33 @@ $logger = $loggerFactory->getFileLogger(
Logger::DEBUG, Logger::DEBUG,
5, 5,
[ [
LoggerFactory::SPECIAL_HANDLERS_LOG_ON_ERROR_ONLY, // simple default implementation LoggerFactory::SPECIAL_HANDLERS_LOG_ON_ERROR_ONLY, // simple default configuration
LoggerFactory::SPECIAL_HANDLERS_BUFFERING, LoggerFactory::SPECIAL_HANDLERS_BUFFERING,
LoggerFactory::SPECIAL_HANDLERS_MAKE_UNIQUE => [ // advanced custom implementation LoggerFactory::SPECIAL_HANDLERS_MAKE_UNIQUE => [ // advanced custom configuration
LoggerFactory::MAKEUNIQUE_OPTION_LEVEL => Logger::INFO LoggerFactory::MAKEUNIQUE_OPTION_LEVEL => Logger::INFO
], ],
],
[] // optional processor flags
);
```
Processors can also be inserted with the analogue configuration:
```
use D3\LoggerFactory\LoggerFactory;
$loggerFactory = LoggerFactory::create();
$logger = $loggerFactory->getFileLogger(
'myPluginLogger',
'plugin_requests.log',
Logger::DEBUG,
5,
[], // optional special handler flags
[
LoggerFactory::PROCESSOR_UNIQUE_ID, // simple default configuration
LoggerFactory::PROCESSOR_FILTERSENSITIVE => [ // simple default configuration
LoggerFactory::FILTERSENSITIVE_SECRETS => ['secret1', 'secret2']
],
] ]
); );
``` ```