ard/monolog-lgpd

Monolog processor for filtering sensitive data

1.0.0 2021-06-29 05:08 UTC

Requires

• php: >=7.4
• monolog/monolog: ^2.2

Requires (Dev)

• phpunit/phpunit: 9.5

MIT

• André Rainaud

• log
• monolog
• processor
• lgpl
• Sensitive data

README

a simple monolog processor for filtering sensitive data

installation

composer require ard/monolog-lgpd

example 1 - with email filter

use ARD\Monolog\FilterSensitive\FilterSensitiveProcessor;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('./log.log', Logger::WARNING));

$processor = new FilterSensitiveProcessor();

$log->pushProcessor($processor);

// add records to the log
$log->warning('The user email is [e-mail]'); //The user email is ****@domain.com

example 2 - with all filters

use ARD\Monolog\FilterSensitive\FilterSensitiveProcessor;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('./log.log', Logger::WARNING));

$processor = new FilterSensitiveProcessor();

$log->pushProcessor($processor);

// add records to the log
$log->warning('The user email is [e-mail]',[
'cpf' => '111.111.111-11',
'cnpj' => '11.111.111/0001-00',
'ip' => '10.0.0.10'
]); 

example 3 - with custom filter

use ARD\Monolog\FilterSensitive\Filter;
use ARD\Monolog\FilterSensitive\FilterSensitiveProcessor;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('./log.log', Logger::WARNING));

$processor = new FilterSensitiveProcessor();

$processor->addCustomFilter(
    new class implements Filter
    {
        public static function pattern(): string
        {
            return '/(^[0-9]{3})\.([0-9]{3})$/';
        }

        public static function replace(): string
        {
            return '$1.***';
        }
    }
);

$log->pushProcessor($processor);

// add records to the log
$log->warning('The user id 123.456'); 

example 4 - remove filter

use ARD\Monolog\FilterSensitive\FilterIP;
use ARD\Monolog\FilterSensitive\FilterSensitiveProcessor;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('./log.log', Logger::WARNING));

$processor = new FilterSensitiveProcessor();

$processor->removeFilter(FilterIP::class);

$log->pushProcessor($processor);

// add records to the log
$log->warning('User [e-mail] and IP 127.0.0.1');