https://github.com/always-open/laravel-request-logger
Log HTTP web requests made from your application
https://github.com/always-open/laravel-request-logger
hacktoberfest laravel logger
Last synced: 3 months ago
JSON representation
Log HTTP web requests made from your application
- Host: GitHub
- URL: https://github.com/always-open/laravel-request-logger
- Owner: always-open
- License: mit
- Created: 2022-04-20T21:30:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-25T13:24:28.000Z (almost 3 years ago)
- Last Synced: 2025-03-05T00:39:58.012Z (over 1 year ago)
- Topics: hacktoberfest, laravel, logger
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Request Logger
[](https://packagist.org/packages/always-open/laravel-request-logger)
[](https://github.com/always-open/laravel-request-logger/actions?query=workflow%3Arun-tests)
[](https://github.com/always-open/laravel-request-logger/actions?query=workflow%3APHPStan)
[](https://packagist.org/packages/always-open/laravel-request-logger)
[](https://codeclimate.com/github/always-open/laravel-request-logger/maintainability)
When making HTTP requests to external APIs it is valuable to track each request and its response. This insight can help
you find issues, track usage, and reuse responses for testing/development.
## Installation
You can install the package via composer:
```bash
composer require always-open/laravel-request-logger
```
## Configuration
``` php
php artisan vendor:publish --provider="\AlwaysOpen\RequestLogger\RequestLoggerServiceProvider"
```
Running the above command will publish the config file.
## Usage
### Creation
To add logs to your system you must first create the migration and model for the appropriate log. This is done by using
the packages `request-logger:make-table` command.
The command needs the name of the item to be tracked and it will be used for naming the model and table.
#### Example
```shell
php artisan request-logger:make-table facebook
```
This will create a model `\App\Models\FacebookRequestLog` and a migration to create the table `facebook_request_logs`
### Implementation
Then you can use that model to create logs of your requests where you can make the API calls.
#### Example
##### Guzzle
```php
function makeFacebookApiCall(array $body, Client $facebook_client)
{
$request_headers = [
'api-key' => $config->apiKey,
'Content-Type' => 'application/json',
];
$versioned_path = self::buildVersionedUrlPath($path);
$encoded_body = json_encode($body, JSON_UNESCAPED_SLASHES);
$request = new Request(
'GET',
'/v1/users',
$request_headers,
$encoded_body,
);
$request_log = FacebookRequestLog::makeFromGuzzle($request);
$response = $client->send($request);
$request_log->response_code = $response->getStatusCode();
$request_log->response = json_decode((string)$response->getBody(), true);
$request_log->save();
}
```
You can also manually set each property and then save the log instance.
### Testing
``` bash
composer test
```
### Using Docker
All assets are set up under the docker-compose.yml file. The first time you run the docker image you must build it with
the following command:
```bash
./docker.sh -b -s
```
Then you can bring it up in the background using:
```bash
./docker.sh -d
```
From there you can run the tests within an isolated environment
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email @qschmick instead of using the issue tracker.
## Credits
- [Quentin Schmick](https://github.com/qschmick)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.