README

Zero configuration logging of Requests and Responses to database or custom drivers in Laravel applications - no more issues debugging customer support requests.

Installation

You can install the package via composer:

composer require bilfeldt/laravel-request-logger

Publish and run the migrations with:

php artisan vendor:publish --provider="Bilfeldt\RequestLogger\RequestLoggerServiceProvider" --tag="request-logger-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --provider="Bilfeldt\RequestLogger\RequestLoggerServiceProvider" --tag="request-logger-config"

Usage

It is possible to enable logging of all or some requests conditionally using one of the approaches below.

Enable log via middleware (Recommended)

This package comes with a convenient requestlog middleware that can be used to enable logging of request by simply registering the middleware on the routes (or route groups) you wish to log:

Route::middleware('requestlog')->get('/', function () {
    return 'Hello World';
});

Enable via config file

The config file includes some convenient settings for enabling logging of all or some requests:

// Enable all requests:
'log_methods' => ['*'],

// or enable all server errors
'log_statuses' => ['5**'],

Enable log via request

This package adds a macro on the Illuminate\Http\Request class making it possible to enable logging directly from the request:

/**
 * Index posts.
 *
 * @param  Request  $request
 * @return Response
 */
public function index(Request $request)
{
    $request->enableLog();

    //
}

Extending with custom Drivers

This package implements the Laravel Manager Class making it possible to easily register custom drivers either in your application or by third party packages.

An example driver can be specified as middleware parameters:

Route::middleware('log:example')->get('/', function () {
    return 'Hello World';
});

or via request macro:

$request->enableLog('example');

Pruning

The number of logged requests can quickly grow if you are not pruning the logs regularly. In order to keep the logs manageable, you can use the prune command to remove old logs as described in the Laravel Docs:

$schedule->command('requestlog:prune')->daily();

Note that the default RequestLog model setup by this package will not be discovered as a "Prunable" model by Laravel default model:prune command as it does not reside in the app/Models directory. If you change this class in the configuration to a custom class this will be auto registered and the command above will be needless.

Notes and advises

Storing logs in a dedicated database

The RequestLog model uses the application's default database connection. To store logs in a separate database (e.g. a dedicated logging database to keep them out of your main application data), set the REQUEST_LOGGER_DB_CONNECTION environment variable to a connection name configured in config/database.php:

REQUEST_LOGGER_DB_CONNECTION=logging

When using a connection that points at a different database than the users table, drop the user_id foreign key constraint in the migration — cross-database foreign keys cannot be enforced. Replace foreignId('user_id')->constrained()->cascadeOnDelete() with unsignedBigInteger('user_id')->nullable()->index().

Proxies and load balancers

When using proxies and/or load balancers then the IP address of the proxy/load balancer must be listed as a Trusted Proxy for the users IP address to be correctly logged as the IP of the proxy itself will be logged otherwise.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Anders Bilfeldt
• Laravel Telescope: Collection of data from request/response is almost entirely taken from this package.
• All Contributors

License

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