creativeorange/laravel-served-by

Automatically set the Served By for requests in your Laravel Framework.

v4.0.0 2024-08-19 08:55 UTC

Requires

• php: ^8.0.2
• illuminate/support: ^9|^10|^11

MIT

• Creativeorange B.V.

• laravel
• creativeorange
• served-by

README

Useful middleware for Laravel Requests & Jobs to determine which server is serving (or running) the request. For HTTP requests, the identifier string will be sent back as HTTP Header "X-Served-By". In jobs, it is possible to send Context to Flare, or tag the server in Horizon.

Installation

You can install the package via composer:

composer require creativeorange/laravel-served-by

For Laravel 8 or lower please install version 1.

Usage HTTP requests

To allow Served By for all your routes, add the ServedBy middleware at the top of the $middleware property of app/Http/Kernel.php class:

protected $middleware = [
    \Creativeorange\ServedBy\Http\Middleware\ServedBy::class,
    // ...
];

Flare

If you use Flare, you can add the following to your job(s):

    /**
     * Get the middleware the job should pass through.
     *
     * @return array
     */
    public function middleware()
    {
        return [new Creativeorange\ServedBy\Http\Middleware\Jobs\ServedBy];
    }

Configuration

The defaults are set in config/served-by.php. Publish the config to copy the file to your own config:

php artisan vendor:publish --tag="served-by"

By default, you can also overwrite the identifier string by adding SERVED_BY_IDENTIFIER to your .env

Credits

• Creativeorange B.V.
• All Contributors

License

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