sadekd/laravel-request-id

Laravel Request ID (XRID)

This Laravel package to help you add X-Request-ID feature into your Laravel app

The HTTP X-Request-ID request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request.

Installation

composer require sadekd/laravel-request-id

Config

php artisan vendor:publish --provider="SadekD\LaravelRequestId\LaravelRequestIdServiceProvider"

Configuration is commented in the config file

Usage

Register the middleware as high in the stack as possible (higher is better — on a later failure you still have the XRID in logs, the response, etc.). The package registers a request-id middleware alias automatically.

Laravel 11+ (bootstrap/app.php)

->withMiddleware(function (Middleware $middleware) {
    $middleware->prepend(\SadekD\LaravelRequestId\Http\Middleware\RequestId::class);
    // or: $middleware->prepend('request-id');
})

Laravel 10 (app/Http/Kernel.php)

protected $middleware = [
    \SadekD\LaravelRequestId\Http\Middleware\RequestId::class,
    // or just 'request-id',
];

Reading the ID

use SadekD\LaravelRequestId\Facades\RequestId;

RequestId::getId();   // current request's ID
app('request-id')->getId();

Config options

Published to config/request-id.php:

License

The MIT License (MIT). Please see License File for more information.