Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twineis/raven-php
Sentry (Raven) error monitoring for Laravel and Lumen with send in background via queues
https://github.com/twineis/raven-php
Last synced: 3 months ago
JSON representation
Sentry (Raven) error monitoring for Laravel and Lumen with send in background via queues
- Host: GitHub
- URL: https://github.com/twineis/raven-php
- Owner: twine-net
- License: mit
- Created: 2016-04-20T06:50:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-31T15:18:11.000Z (almost 6 years ago)
- Last Synced: 2024-06-23T16:07:24.945Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 16.6 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Raven PHP
=============
> Sentry (Raven) error monitoring for Laravel and Lumen with send in background via queues
[](http://www.opensource.org/licenses/MIT)
[](https://packagist.org/packages/twineis/raven-php)
[](https://packagist.org/packages/twineis/raven-php)
Sentry (Raven) error monitoring for Laravel and Lumen with send in background via queues. This will add a listener to Laravel's existing log system. It makes use to Laravel's queues to push messages into the background without slowing down the application.
## Installation
Install the latest version with:
```bash
$ composer require twineis/raven-php
```
For Laravel add the service provider in `config/app.php`:
```php
Twine\Raven\Providers\LaravelServiceProvider::class,
```
Register the Raven alias:
```php
'Raven' => Twine\Raven\Facades\Raven::class,
```
For Lumen add the following to `bootstrap/app.php`
```php
$app->register(Twine\Raven\Providers\LumenServiceProvider::class);
```
## Configuration
Publish the included configuration file **(Laravel only)**:
```bash
$ php artisan vendor:publish
```
Change the Sentry DSN by using the `RAVEN_DSN` env variable or changing the config file:
```php
RAVEN_DSN=your-raven-dsn
```
This library uses the queue system, make sure your `config/queue.php` file is configured correctly. You can also specify the connection and the queue to use in the raven config. The connection and queue must exist in `config/queue.php`. These can be set using the `RAVEN_QUEUE_CONNECTION` for connection and `RAVEN_QUEUE_NAME` for the queue.
```php
RAVEN_QUEUE_CONNECTION=redis
RAVEN_QUEUE_NAME=error
```
**The job data can be quite large, ensure you are using a queue that can support large data sets like `redis` or `sqs`**.
If the job fails to add into the queue, it will be sent directly to sentry, slowing down the request, so its not lost.
## Usage
To monitor exceptions, simply use the `Log` facade or helper:
```php
Log::error($exception);
// or
app('log')->error($exception);
```
You can change the logs used by changing the log level in the config by modifying the env var.
```php
RAVEN_LEVEL=error
```
### Event Id
There is a method to get the **last** event id so it can be used on things like the error page.
```php
Raven::getLastEventId();
```
### Context information
You can pass additional information as context like this:
```php
Log::error('Oops, Something went wrong', [
'user' => ['name' => $user->name, 'email' => $user->email]
]);
```
## Credits
This package was inspired [rcrowe/Raven](https://github.com/rcrowe/Raven).