Download the PHP package goedemiddag/request-response-log without Composer
On this page you can find all versions of the php package goedemiddag/request-response-log. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download goedemiddag/request-response-log
More information about goedemiddag/request-response-log
Files in goedemiddag/request-response-log
Package request-response-log
Short Description Package for logging (external) requests and the responses
License MIT
Homepage https://github.com/goedemiddag/request-response-log
Informations about the package request-response-log
RequestResponseLog
This package for Laravel applications provides a middleware for logging HTTP requests and responses, both incoming to, or outgoing from your Laravel application. It offers:
- Middleware to be used with the Laravel HTTP client, Guzzle and Saloon.
- Middleware to log requests made to your application and its response.
- Functionality to manual logs requests and responses.
It's originally created to log API requests to other services and to log incoming webhooks, but can be used for any request and response logging.
Requirements
This package requires Laravel 10+ and PHP 8.3+.
Installation
You can install the package via composer:
The package will automatically register itself in Laravel, but you need to run the migrations:
You are now ready to use the package.
Usage
This package provides two middleware solutions:
- Logging HTTP requests and responses, to be used with the Laravel HTTP client, Guzzle and Saloon.
- Logging Requests and Responses from your application.
HTTP Logger
Laravel HTTP client
When using the Laravel HTTP client:
Guzzle
When initializing the client:
Saloon
In the constructor of the connector:
Application logger
The package provides a middleware for your Laravel application called ApplicationRequestResponseLogger
. This will log
the incoming request and the response your application generates. This is originally use for logging incoming webhooks,
but feel free to use it for anything you like. Just register the middleware to a group or apply it to a route
individually:
Manual logger
The package provides a logger for manual logging of requests and responses. This can be useful when you want to log requests and responses that do not support the middleware or any other use case you can come up with.
Configuration
The package provides a configuration file that allows you to configure the package to your needs. You can change the table names to your likings, change the database connection (so you can store the logs somewhere else than your default database), determine which fields should be masked (even per vendor), etc. The configuration file can be published by running:
The configuration file will be published to config/request-response-log.php
. The configuration file contains comments
to explain more about the options.
The migrations are loaded automatically and can't be published, as everything you can configure about it, is in the configuration.
Cleaning up
This package uses the default model prune functionality from Laravel to clean up old logs. You can configure the amount of days to keep logs in the configuration file. To clean up the logs automatically, schedule the model prune command and pass the model you want to prune:
Laravel 11
Add the following to your routes/console.php
file:
Laravel 10
Add the following to your app/Console/Kernel.php
file:
Contributing
Found a bug or want to add a new feature? Great! There are also many other ways to make meaningful contributions such as reviewing outstanding pull requests and writing documentation. Even opening an issue for a bug you found is appreciated.
When you create a pull request, make sure it is tested, following the code standard (run composer code-style:fix
to
take care of that for you) and please create one pull request per feature. In exchange, you will be credited as
contributor.
Testing
To run the tests, you can use the following command:
Security
If you discover any security related issues in this or other packages of Goedemiddag, please email [email protected] instead of using the issue tracker.
About Goedemiddag
Goedemiddag! is a digital web-agency based in Delft, the Netherlands. We are a team of professionals who are passionate about the craft of building digital solutions that make a difference for its users. See our GitHub organisation for more package.