zooxsmart/request-id

PHP middleware to add a Request ID header

1.0.2 2023-11-08 08:29 UTC

Requires

• php: ^8.2
• psr/container: ^1.0 || ^2.0
• psr/http-message: ^1.0
• psr/http-server-middleware: ^1.0
• ramsey/uuid: ^4.1

Requires (Dev)

• doctrine/coding-standard: ^12.0
• laminas/laminas-diactoros: ^3.2
• phpstan/phpstan: ^1.10.39
• phpunit/phpunit: ^10.4.2
• squizlabs/php_codesniffer: ^3.7.2
• vimeo/psalm: ^5.15

MIT

• Leandro Silva

README

This middleware adds a Request ID header that can be used to trace back requests (logs).

It uses [Ramsey\Uuid(https://github.com/ramsey/uuid) library as default uuid generation.

Usage

Just add the middleware as one of the first in your application.

For example:

$app->pipe(new \LosMiddleware\RequestId\RequestId($options);

And the middleware will add a header to the request AND response

X-Request-Id: 56CEE969-4D3B-404E-9938-03E769E191CB

The options are:

• allow_override: If it's allowed to override a previouly added request id header. Default: false
• header_name: Header name. Default: X-Request-Id

Laminas

If you are using laminas-skeleton, you can copy config/los-request-id.global.php.dist to config/autoload/los-request-id.global.php and modify configuration as your needs.