potsky/rollbar-laravel

Rollbar error monitoring integration for Laravel projects

v2.0.1 2017-06-21 14:59 UTC

Requires

• php: >=5.4
• illuminate/support: ^4.0|^5.0
• rollbar/rollbar: ^1.0

Requires (Dev)

• mockery/mockery: ^0.9
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~4.0|~5.0
• satooshi/php-coveralls: ^1.0
• squizlabs/php_codesniffer: 2.*

MIT

• Jens Segers
• Artur Moczulski
• Potsky

• logging
• error
• monitoring
• laravel
• rollbar

README

Installation

Install using composer:

composer require potsky/rollbar-laravel

Add Project Access Token post_server_item from Rollbar.com -> Settings -> Project Access Tokens to .env:

ROLLBAR_TOKEN=[your Rollbar project access token]

Add the service provider to the 'providers' array in config/app.php:

Rollbar\Laravel\RollbarServiceProvider::class,

If you only want to enable Rollbar reporting for certain environments you can conditionally load the service provider in your AppServiceProvider:

if ($this->app->environment('production')) {
    $this->app->register(\Rollbar\Laravel\RollbarServiceProvider::class);
}

Configuration

This package supports configuration through the services configuration file located in config/services.php. All configuration variables will be directly passed to Rollbar:

'rollbar' => [
    'access_token' => env('ROLLBAR_TOKEN'),
    'level' => env('ROLLBAR_LEVEL'),
    'person_fn' => function() {
		if (Auth::user()) {
			return [
				'id'       => strval(Auth::user()->id),
				'username' => strval(Auth::user()->name),
				'email'    => strval(Auth::user()->email),
			];
		} else {
			return [];
		}
	}
],

The level variable defines the minimum log level at which log messages are sent to Rollbar. For development you could set this either to debug to send all log messages, or to none to sent no messages at all. For production you could set this to error so that all info and debug messages are ignored.

If you compile configuration files, do not use a callback function directly. Define the function in a helper include for example and configure the service like this :

'rollbar' => [
    'access_token' => env('ROLLBAR_TOKEN'),
    'level' => env('ROLLBAR_LEVEL'),
    'person_fn' => 'get_rollbar_person'
],

In the helper file:

function get_rollbar_person() {
	if (Auth::user()) {
		return [
			'id'       => strval(Auth::user()->id),
			'username' => strval(Auth::user()->name),
			'email'    => strval(Auth::user()->email),
		];
	} else {
		return [];
	}
}

Usage

Fatal error and exceptions handled by Laravel are automatically sent to Rollbar. You do not need to add something in app/Exceptions/Handler.php.

Your other log messages will also be sent to Rollbar:

\Log::debug('Here is some debug information');

Context informaton

You can pass extra information:

\Log::warning('Something went wrong', [
    'download_size' => 3432425235
]);