Skip to content

Commit

Permalink
Merge pull request #52 from sdebacker/patch-1
Browse files Browse the repository at this point in the history
Syntax highlighting + a namespace
  • Loading branch information
jenssegers committed May 3, 2016
2 parents 9ef95ce + dea6c9e commit be232a8
Showing 1 changed file with 39 additions and 23 deletions.
62 changes: 39 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,21 @@ Installation

Install using composer:

composer require jenssegers/rollbar
```
composer require jenssegers/rollbar
```

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

Jenssegers\Rollbar\RollbarServiceProvider::class,
```php
Jenssegers\Rollbar\RollbarServiceProvider::class,
```

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

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

Expand All @@ -31,10 +35,12 @@ 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' => array(
'access_token' => env('ROLLBAR_TOKEN'),
'level' => env('ROLLBAR_LEVEL'),
),
```php
'rollbar' => [
'access_token' => env('ROLLBAR_TOKEN'),
'level' => env('ROLLBAR_LEVEL'),
],
```

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.

Expand All @@ -43,36 +49,46 @@ Usage

To automatically monitor exceptions, simply use the `Log` facade in your error handler in `app/Exceptions/Handler.php`:

public function report(Exception $e)
{
\Log::error($e);
```php
public function report(Exception $e)
{
\Log::error($e);
return parent::report($e);
}
```

return parent::report($e);
}

For Laravel 4 installations, this is located in `app/start/global.php`:

App::error(function(Exception $exception, $code)
{
Log::error($exception);
});
```php
App::error(function(Exception $exception, $code)
{
Log::error($exception);
});
```

Your other log messages will also be sent to Rollbar:

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

*NOTE*: Fatal exceptions will always be sent to Rollbar.

### Context informaton

You can pass user information as context like this:

\Log::error('Something went wrong', [
'person' => ['id' => 123, 'username' => 'John Doe', 'email' => '[email protected]']
]);
```php
\Log::error('Something went wrong', [
'person' => ['id' => 123, 'username' => 'John Doe', 'email' => '[email protected]']
]);
```

Or pass some extra information:

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

0 comments on commit be232a8

Please sign in to comment.