Flexible and extendable logging of Laravel application request and responses
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();
//
}
Unique Request UUID
This package adds a macro getUniqueId() for the Illuminate\Http\Request class which generates a unique request UUID that will be saved to the logs and that can be included as Global Log Context which will pass it onto any application logging or error reporting. This id will per default also be added as a custom response header.
This is an extremely helpful trick when debugging customer requests as both customer, application logs, reported errors and request logs (this package) now all include a single common UUID!
$request->getUniqueId(); // Example: 94d0e2d6-4cc6-449c-9140-80bca47d29b4
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
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.
334 Jan 6, 2023
356 Dec 30, 2022
68 Dec 15, 2022
41 Jul 29, 2022
7 Jul 25, 2022
76 Sep 28, 2022
2 Sep 9, 2022
475 Dec 22, 2022
4 Apr 26, 2022
107 Dec 12, 2022
73 Nov 14, 2022
20.1k Jan 8, 2023
331 Dec 21, 2022
99 Jan 3, 2023
27 Nov 24, 2022
136 Jan 4, 2023
28 Nov 29, 2022
6 Sep 27, 2021
196 Dec 28, 2022