devsquad-cockpit/laravel

A Freemium package to help you tracking the project errors

v3.0.2 2024-03-29 17:04 UTC

Requires

• php: ^8.2|^8.3
• ext-json: *
• guzzlehttp/guzzle: ^7.5
• illuminate/log: ^11.0
• illuminate/support: ^11.0
• spatie/backtrace: ^1.2

Requires (Dev)

• brianium/paratest: ^7.4
• friendsofphp/php-cs-fixer: ^3.0
• orchestra/testbench: ^9.0
• phpmd/phpmd: ^2.9
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.6

MIT

• DevSquad

README

Cockpit is a beautiful error tracking package that will help your software team to track and fix errors.

Table Of Compatibility

Laravel Version	Cockpit Version
^10	^2.0
^11	^3.0

Now you can install the package:

composer require devsquad-cockpit/laravel

Run the following command to install the package files:

php artisan cockpit:install

Configuring cockpit connection

After the installation, you should configure the connection with cockpit main application. Open your .env file and check for this new env vars:

COCKPIT_DOMAIN=
COCKPIT_ENABLED=
COCKPIT_TOKEN=

COCKPIT_DOMAIN: You must set your cockpit domain on this var. This way, our package will know where it should send the error data. If your cockpit instance runs on a port different than the 80 or 443, you should add it too. E.g.: http://cockpit.mydomain.com:9001.

COCKPIT_ENABLED: With this var, you can control if cockpit features will be available or not.

COCKPIT_TOKEN: On this var, you should set the project token. With this, you instruct cockpit in which project the errors will be attached.

Reporting unhandled exceptions

You need to add the Cockpit as a log-channel by adding the following config to the channels section in config/logging.php:

'channels' => [
    // ...
    'cockpit' => [
        'driver' => 'cockpit',
    ],
],

After that you need to fill it on LOG_STACK env:

LOG_STACK=cockpit

Testing if everything works

By the end you're being able to send a fake exception to test connection

php artisan cockpit:test