https://github.com/craigpotter/barstool
A logger for SaloonPHP when using Laravel
https://github.com/craigpotter/barstool
laravel saloonphp
Last synced: 11 months ago
JSON representation
A logger for SaloonPHP when using Laravel
- Host: GitHub
- URL: https://github.com/craigpotter/barstool
- Owner: craigpotter
- License: mit
- Created: 2023-11-28T21:38:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-16T16:04:27.000Z (12 months ago)
- Last Synced: 2025-07-19T02:38:47.942Z (11 months ago)
- Topics: laravel, saloonphp
- Language: PHP
- Homepage:
- Size: 85.9 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Barstool
[](https://packagist.org/packages/craigpotter/barstool)
[](https://github.com/craigpotter/barstool/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/craigpotter/barstool/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/craigpotter/barstool)
> [!CAUTION]
> This package is currently in development and using in production should be at your own risk.
> Breaking changes could still happen before a stable v1.0. Please check back soon for updates.
Bartool is a dedicated Laravel package to help you keep track of your [Saloon](https://github.com/saloonphp/saloon) requests & responses.
Barstool will allow you to easily view, search, and filter your logs directly in your database tool of choice.
The package is designed to be as simple as possible to get up and running, with minimal configuration required.
So pull up a barstool, grab a drink, and let's get logging in the Saloon! Yeehaw!
## Installation
You can install the package via composer:
```bash
composer require craigpotter/barstool
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="barstool-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="barstool-config"
```
You should also set up Laravel Model Pruning in your scheduler. Please check the Laravel Documentation for your version to know where to put the code below.
```php
use CraigPotter\Barstool\Models\Barstool;
Schedule::command('model:prune', [
'--model' => [Barstool::class],
])->daily();
```
## Usage
That's all folks!
Once installed, it will start logging your [Saloon](https://github.com/saloonphp/saloon) requests automatically.
Check the config out for more control.
Here are some of the things you can see with Barstool:
- Request Method
- Connector Used
- Request Used
- Request URL
- Request Headers
- Request Body
- Response Status Code
- Response Headers
- Response Body
- Response Duration
The logging will even log fatal errors caused by your saloon requests so you can see what went wrong.
> [!TIP]
> We will be adding more features soon, so keep an eye out for updates!
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](./.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
If you discover any security related issues, please email barstool@craigpotter.co.uk instead of using the issue tracker.
## Credits
- [Craig Potter](https://github.com/craigpotter)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.