README

A Symfony bundle that removes PII and secrets from your Monolog logs before they reach Sentry, DataDog, log files or any other handler.

It wires the pii-sanitizer-php Monolog processor into MonologBundle. The processor sends each record to the local PII Sanitizer Engine over a Unix socket.

Before:  app.ERROR: Payment failed for John Doe {"email":"john.doe@example.com"}
After:   app.ERROR: Payment failed for [PRIVATE_PERSON] {"email":"[PRIVATE_EMAIL]"}

Requirements

PHP ≥ 8.1
Symfony 6.4, 7.x or 8.x (Symfony 8 itself requires PHP 8.4)
MonologBundle 3.10 or later, or 4.x
A running PII Sanitizer Engine container whose socket your PHP-FPM user can read and write. See the engine README and the compose example.

Install

composer require lucajackal85/pii-sanitizer-symfony

This also installs lucajackal85/pii-sanitizer-php, the socket client and Monolog processor the bundle wires up.

In an app that uses Symfony Flex (the default), that's all: Flex adds the bundle to config/bundles.php for you. Without Flex, register it yourself:

// config/bundles.php
return [
    // ...
    Jackal\PiiSanitizer\Bundle\PiiSanitizerBundle::class => ['all' => true],
];

Configure

Every option is optional. These are the defaults:

# config/packages/pii_sanitizer.yaml
pii_sanitizer:
  socket_path: '/tmp/sockets/pii_sanitizer.sock'   # e.g. '%env(PII_SOCKET_PATH)%'
  connect_timeout: 0.05        # seconds
  read_timeout: 1.0            # seconds
  on_failure: redact           # redact | passthrough
  circuit_breaker_seconds: 5
  channels: []                 # empty = every channel; e.g. [app, security]

The bundle registers the processor with the monolog.processor tag. MonologBundle then adds it to every logger channel, or only to the channels you list. It runs before your handlers, so Sentry, DataDog and files only ever receive the scrubbed record.

To scrub only what leaves the server, list just those channels. Log calls wait for the engine, which on CPU takes about 100–400 ms for a new line.

Every channel you list must exist in Monolog: app, the channels declared under monolog.channels, or a channel a service logs to (for example security, php, request). An unknown name stops the container from compiling, with an error under pii_sanitizer.channels that lists the channels your app has. The bundle also refuses to start without MonologBundle, because records would silently not be sanitized.

When the engine is unavailable

`on_failure`	Behaviour
`redact` (default)	The message becomes `[PII_SANITIZER_UNAVAILABLE]` and the context is dropped. Nothing leaks.
`passthrough`	The record is logged unchanged, and may contain PII.

After a failure the processor stops calling the engine for circuit_breaker_seconds, so a dead engine doesn't slow down every request. See the pii-sanitizer-php README for details.

Development

composer install
composer check        # php-cs-fixer + rector (dry run), PHPStan and PHPUnit, like CI
composer cs-fix       # apply php-cs-fixer
composer rector-fix   # apply rector

The tests compile a container with the real MonologBundle and check that the processor ends up on the right channel loggers.

Releases

Every pull request merged into main is tagged automatically with the next version, and a GitHub Release with the list of merged PRs is published. Packagist picks up new tags on its own.

The version bump is set with a label on the PR:

Label	Example
(none)	`v0.1.0` → `v0.1.1`
`minor`	`v0.1.0` → `v0.2.0`
`major`	`v0.1.0` → `v1.0.0`
`skip-release`	no new version, e.g. for docs or CI changes

Upgrading from 0.1

In 0.2 the namespaces changed: the bundle's from OpenPii\PiiSanitizerBundle\ to Jackal\PiiSanitizer\Bundle\, and pii-sanitizer-php's from OpenPii\MonologSanitizer\ to Jackal\PiiSanitizer\. The configuration (pii_sanitizer:) and the behaviour are unchanged.

Update config/bundles.php by hand. Flex does not rename the entry on composer update, and the app fails with Class "OpenPii\PiiSanitizerBundle\PiiSanitizerBundle" not found until you do. Edit the file before or right after updating:
```
// before
OpenPii\PiiSanitizerBundle\PiiSanitizerBundle::class => ['all' => true],
// after
Jackal\PiiSanitizer\Bundle\PiiSanitizerBundle::class => ['all' => true],
```
Require the new version. -W also upgrades pii-sanitizer-php to 0.2, which the new bundle needs; without it Composer refuses, because the lock file keeps pii-sanitizer-php at 0.1:
```
composer require -W lucajackal85/pii-sanitizer-symfony:^0.2
```
If your own code uses the client or processor classes directly, replace OpenPii\MonologSanitizer\ with Jackal\PiiSanitizer\ in its use statements.

License

MIT. See LICENSE.

lucajackal85 / pii-sanitizer-symfony

Package info

Security

Statistics