laravel maintained by rocketeers-app
Rocketeers for Laravel
Laravel integration package with Rocketeers app.
Installation
You can install this package via Composer:
composer require rocketeers-app/rocketeers-laravel
Configure rocketeers in your stack logging configuration, so you keep your normal logging with additional Rocketeers logging:
'channels' => [
'stack' => [
'driver' => 'stack',
'channels' => ['rocketeers', 'daily'],
'ignore_exceptions' => false,
],
'rocketeers' => [
'driver' => 'rocketeers',
'level' => 'debug',
],
// ...
Make sure that in the logging configuration the default log channel is stack:
'default' => env('LOG_CHANNEL', 'stack'),
Publish the configuration file:
php artisan vendor:publish --provider="Rocketeers\Laravel\RocketeersLoggerServiceProvider" --tag="config"
This will create a config/rocketeers.php file with the following defaults:
<?php
return [
'api_token' => env('ROCKETEERS_API_TOKEN'),
'environments' => [
'production',
],
'horizon' => [
'enabled' => env('ROCKETEERS_HORIZON_ACCESS', true),
],
'sensitive_fields' => [
'password',
'password_confirmation',
'token',
'secret',
'credit_card',
'card_number',
'cvv',
'ssn',
'authorization',
],
];
Add the ROCKETEERS_API_TOKEN to your .env file.
Horizon access
When Laravel Horizon is installed, this package lets Rocketeers reach the Horizon dashboard and its API by sending your ROCKETEERS_API_TOKEN as a bearer token:
Authorization: Bearer <ROCKETEERS_API_TOKEN>
No extra setup is needed. The package wraps the authorization callback that is already registered — your own viewHorizon gate and any Horizon::auth() callback keep working exactly as before, this only adds the token as an extra way in.
Turn it off by setting ROCKETEERS_HORIZON_ACCESS=false in your .env file, or by setting rocketeers.horizon.enabled to false.
Note that Horizon runs in the web middleware group, so its POST endpoints (retrying jobs, for example) are still subject to CSRF protection. Reading queue metrics over the API works out of the box; if you also want Rocketeers to perform actions, exclude horizon/* from CSRF verification in your application.
Testing the integration
To verify that error reporting is wired up correctly, run:
php artisan rocketeers:test
This sends a test error to Rocketeers so you can confirm it arrives in your dashboard. The command checks that a ROCKETEERS_API_TOKEN is configured, warns when the current environment is not listed in rocketeers.environments (real errors would not be reported there), and reports the API error if sending fails.
Changelog
Please see CHANGELOG for more information what has changed recently.
For Laravel 10.x and up use v2.0.0.
For Laravel 9.x and below use v1.0.0 or the release/v1 branch.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email mark@vaneijk.co instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.