xepozz/request-id

There is no license information available for the latest version (1.0.0) of this package.

Tracing request and response IDs for Yii 3

1.0.0 2023-04-08 12:04 UTC

Requires

• php: ^8.1
• psr/http-server-middleware: ^1.0
• ramsey/uuid: ^4.7.3

Requires (Dev)

• nyholm/psr7: ^1.5.1
• phpunit/phpunit: 10.0.17
• vimeo/psalm: ^5.8
• yiisoft/yii-debug: dev-split-debug

Unknown License

• yii
• request-id
• tracing
• yii3

README

This is a simple library to generate both unique request and response IDs for tracing purposes.

Installation

composer require xepozz/request-id

Usage

Add the middleware to your application configuration, e.g. config/web/params.php:

use Xepozz\RequestID\SetRequestIDMiddleware;

return [
    'middlewares' => [
        SetRequestIDMiddleware::class,
        // ErrorCatcher::class,
        // SentryMiddleware::class,
        // Router::class,
        // ...
    ],
];

Note: The middleware must be added before the ErrorCatcher middleware if you want to see the response ID in the error page.

Request ID Provider

You can get the request ID with the Xepozz\RequestID\RequestIDProviderInterface interface:

use Xepozz\RequestID\RequestIDProviderInterface;

class HttpClient
{
    public function __construct(
        private RequestIDProviderInterface $requestIDProvider,
    ) {
    }
    
    public function sendRequest(): void
    {
        $requestID = $this->requestIDProvider->get();
        
        // ...
    }
}

Configuration

Using incoming request ID

If you want not to use the Request ID from the incoming request, you can disable this behavior by specifying the useIncomingRequestID parameter in the application configuration:

return [
    'xepozz/request-id' => [
        'useIncomingRequestID' => false,
    ],
];

Note: By default, the library always uses the header to get the request ID from the incoming request.

Request ID header

By default, the library uses the X-Request-ID header to store the request ID. Same header name is used to set response ID. You can change the header name by specifying the headerName parameter in the application configuration:

return [
    'xepozz/request-id' => [
        'headerName' => 'X-Request-ID',
    ],
];

Response ID header

By default, the library sets the header to the response at the end of a request. You can disable this behavior by specifying the setResponseHeader parameter in the application configuration:

return [
    'xepozz/request-id' => [
        'setResponseHeader' => false,
    ],
];

Strategies

By default, the library uses the Xepozz\RequestID\UuidGenerator generator. You can change the strategy by specifying the implementation of the Xepozz\RequestID\RequestIDGeneratorInterface interface in the container:

use Xepozz\RequestID\RequestIDGeneratorInterface;
use Xepozz\RequestID\UuidGenerator;

return [
    RequestIDGeneratorInterface::class => UuidGenerator::class,
];

Looking for more modules?

• Unique ID - Allows you to track the unique user in the application.
• AB - A simple library to enable A/B testing based on a set of rules.
• Feature Flag - A simple library to enable/disable features based on a set of rules.
• Shortcut - Sets of helper functions for rapid development of Yii 3 applications.