xolvio/laravel-gitlab-reporter

GitLab error reporter for Laravel 5

0.1 2019-06-19 08:31 UTC

Requires

• php: >=7.0
• illuminate/container: 5.5.x|5.6.x|5.7.x|5.8.x
• illuminate/database: 5.5.x|5.6.x|5.7.x|5.8.x
• illuminate/http: 5.5.x|5.6.x|5.7.x|5.8.x
• illuminate/support: 5.5.x|5.6.x|5.7.x|5.8.x
• m4tthumphrey/php-gitlab-api: ^9.10
• php-http/guzzle6-adapter: ^1.1
• symfony/console: 4.x|3.x
• symfony/var-dumper: 4.x|3.x

Requires (Dev)

• phpunit/phpunit: ^7

MIT

• Anwar el Bouhdifi

• gitlab
• error reporting

README

Create issues for Exceptions that happen on your servers.

This package will create issues in your Gitlab project if Exceptions occur and will post some more debug information to the issue to help you solve problems.

This package will contact your Gitlab server and checks if an exception has occurred before based on a generated identifier hash in the issue description. Don't remove this line in the description as it will be the only way for this package to validate if an exception occurred before.

Gitlab version 9 or higher required.

Installation

Install with composer

composer require Xolvio/laravel-gitlab-reporter

To use the Gitlab reporter you should change the following in your app/Exceptions/Handler.php file in your Laravel project

public function report(Exception $exception)
{
    // Ignore Gitlab Report in code coverage
    // @codeCoverageIgnoreStart
    if(env('APP_ENV') == 'production' && $this->shouldReport($exception)){
        app('gitlab.report')->report($exception);
    }
    // @codeCoverageIgnoreEnd

    parent::report($exception);
}

To test if your connection and settings work you could temporarily remove the env('APP_ENV') check, run the settings locally and see if everything works

Now setup your .env file to include the following variables:

GITLAB_REPORT_URL=https://gitlab.com/
GITLAB_REPORT_TOKEN=
GITLAB_REPORT_PROJECT_ID=
GITLAB_REPORT_LABELS=

I would suggest making a seperate user account for the reporter and only let it access Issues and allow it for issue creation. This way you can ensure if your server or code gets compromised you won't give full access to the server

To retrieve an access token go to your gitlab server to profile/personal_access_tokens and generate a token for using the API

For your Project ID you need to go to your project -> Settings -> General -> General Project settings. There should be a box with Project ID

Adding labels to issues

Adding labels to newly created issues is easy, just add a comma-separated list to GITLAB_REPORT_LABELS=

GITLAB_REPORT_LABELS=bug,critical

If the labels don't exist in Gitlab they will be automatically created.

Ignoring certain exceptions

Make sure you publish the config as setting exceptions is not possible using an .env file

php artisan vendor:publish --tag=gitlab-report

A file called gitlab-report.php will be created there and you can change settings there. A couple of exceptions have been added by default

Redacting fields in reports

In some cases you don't want reports to contain passwords of your clients. You can extend or replace values in the configuration file to include more fields that shouldn't show up in a report. All these fields will be replaced with [redacted]. Fields that are filled with null will also be replaced with [redacted]