Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-middleware/request-id
PSR-7 Request ID (Correlation ID) middleware
https://github.com/php-middleware/request-id
correlation-id middleware monolog psr-15 psr-7 request-id uuid
Last synced: 16 days ago
JSON representation
PSR-7 Request ID (Correlation ID) middleware
- Host: GitHub
- URL: https://github.com/php-middleware/request-id
- Owner: php-middleware
- License: mit
- Created: 2015-08-31T22:20:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T20:08:16.000Z (over 3 years ago)
- Last Synced: 2024-09-19T16:35:37.617Z (about 2 months ago)
- Topics: correlation-id, middleware, monolog, psr-15, psr-7, request-id, uuid
- Language: PHP
- Homepage:
- Size: 58.6 KB
- Stars: 34
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-http - php-middleware/request-id
README
# Request ID middleware for PHP
[](https://travis-ci.org/php-middleware/request-id)
PSR-7 Request ID middleware
This middleware provide framework-agnostic possibility to generate and add to request/response's header Request ID (Correlation ID).
## Installation
```bash
composer require php-middleware/request-id
```
## Usage
This middleware require in contructor `PhpMiddleware\RequestId\RequestIdProviderFactoryInterface` implementation which
must create a new `RequestIdProviderInterface` object. We provide `RequestIdProvider` default implementation.
```php
$generator = new PhpMiddleware\RequestId\Generator\PhpUniqidGenerator();
$requestIdProvider = new PhpMiddleware\RequestId\RequestIdProviderFactory($generator);
$requestIdMiddleware = new PhpMiddleware\RequestId\RequestIdMiddleware($requestIdProvider);
$app = new MiddlewareRunner();
$app->add($requestIdMiddleware);
$app->run($request, $response);
```
All Provider factory constructor options:
* `PhpMiddleware\RequestId\Generator\GeneratorInterface` `$generator` - generator implementation (required)
* `bool|PhpMiddleware\RequestId\OverridePolicy\OverridePolicyInterface` `$allowOverride` (default `true`) - if `true` and request id header exists in incoming request, then value from request header will be used in middleware, using generator will be avoid
* `string` `$requestHeader` (default `X-Request-Id`) - request header name
How to get request id in my application?
* Middleware implements `RequestIdProviderInterface`, so you are able to use `getRequestId()` method,
* from `request-id` attribute in `ServerRequest` object (`$request->getAttribute(RequestIdMiddleware::ATTRIBUTE_NAME)`).
### Override policy
You can add your own logic to decide when override incoming request id. You can implement `OverridePolicyInterface` and pass it as `$allowOverride` variable in constructor.
### Monolog processor
We provide simple [Monolog](https://github.com/Seldaek/monolog) [processor](src/MonologProcessor.php) to add request it to every log entry!
### Request decorator
[RequestDecorator](src/RequestDecorator.php) adds header with request id to your request object. It's useful when your microservices communicate between using PSR-7 HTTP messages e.g. [Guzzle](https://github.com/guzzle/guzzle).
### Request Id generators
To generate request id you need to use implementation of `PhpMiddleware\RequestId\Generator\GeneratorInterface`. There are predefined generators in `PhpMiddleware\RequestId\Generator\` namespace:
#### PhpUniqidGenerator
Simple generator using [uniqid](http://php.net/manual/en/function.uniqid.php) function.
#### RamseyUuid1Generator
[UUID](https://tools.ietf.org/html/rfc4122)1 implementations of [Ramsey\Uuid](https://github.com/ramsey/uuid). To use it you need to add `ramsey/uuid` dependency to your `composer.json`.
#### RamseyUuid3Generator
[UUID](https://tools.ietf.org/html/rfc4122)3 implementations of [Ramsey\Uuid](https://github.com/ramsey/uuid). To use it you need to add `ramsey/uuid` dependency to your `composer.json`.
#### RamseyUuid4Generator
[UUID](https://tools.ietf.org/html/rfc4122)4 implementations of [Ramsey\Uuid](https://github.com/ramsey/uuid). To use it you need to add `ramsey/uuid` dependency to your `composer.json`.
#### RamseyUuid4StaticGenerator
Generates Uuid4 like `RamseyUuid4Generator` however it's not require any dependency (it use static factory method).
#### RamseyUuid5Generator
[UUID](https://tools.ietf.org/html/rfc4122)5 implementations of [Ramsey\Uuid](https://github.com/ramsey/uuid). To use it you need to add `ramsey/uuid` dependency to your `composer.json`.
#### PrefixedGenerator
It adds prefix to generated request id.
#### Md5Generator
This generator converts generated request id to md5 hash.
## It's just works with any modern php framework!
Middleware tested on:
* [Expressive](https://github.com/zendframework/zend-expressive)
Middleware should works with:
* [Slim 3.x](https://github.com/slimphp/Slim)
And any other modern framework [supported middlewares and PSR-7](https://mwop.net/blog/2015-01-08-on-http-middleware-and-psr-7.html).