devsquad-cockpit/cockpit

This package is abandoned and no longer maintained. The author suggests using the devsquad-cockpit/laravel package instead.

A Freemium package to help you tracking the project errors

v2.0.0 2023-02-23 22:08 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.5
• illuminate/log: ^10.0
• illuminate/support: ^10.0
• livewire/livewire: ^2.0
• spatie/backtrace: ^1.2
• spatie/ray: ^1.34

Requires (Dev)

• brianium/paratest: ^6.2
• friendsofphp/php-cs-fixer: ^3.0
• orchestra/testbench: v8.0
• phpmd/phpmd: ^2.9
• phpunit/phpunit: ^9.3.3
• 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.

Laravel Installation

This package is compatible with Laravel 6+.

Now you can install the package:

composer require devsquad/cockpit

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.

Add the following lines to your composer.json file:

"scripts": {
    "post-autoload-dump": [
        "@php artisan cockpit:install --force --ansi"
    ]
}

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 add it to the stack section:

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

Testing if everything works

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

php artisan cockpit:test