Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getsentry/sentry-laravel
The official Laravel SDK for Sentry (sentry.io)
https://github.com/getsentry/sentry-laravel
crash-reporting crash-reports error-monitoring hacktoberfest laravel php sdk sentry sentry-client tag-production team-web-backend
Last synced: 3 days ago
JSON representation
The official Laravel SDK for Sentry (sentry.io)
- Host: GitHub
- URL: https://github.com/getsentry/sentry-laravel
- Owner: getsentry
- License: mit
- Created: 2016-04-26T06:48:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-24T11:07:30.000Z (19 days ago)
- Last Synced: 2024-12-04T17:32:32.351Z (9 days ago)
- Topics: crash-reporting, crash-reports, error-monitoring, hacktoberfest, laravel, php, sdk, sentry, sentry-client, tag-production, team-web-backend
- Language: PHP
- Homepage: https://sentry.io
- Size: 1.4 MB
- Stars: 1,261
- Watchers: 58
- Forks: 189
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- favorite-link - Laravel 为 Sentry 整合。
README
_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_
# Official Sentry SDK for Laravel
[](https://github.com/getsentry/sentry-laravel/actions/workflows/ci.yaml)
[](https://packagist.org/packages/sentry/sentry-laravel)
[](https://packagist.org/packages/sentry/sentry-laravel)
[](https://packagist.org/packages/sentry/sentry-laravel)
[](https://packagist.org/packages/sentry/sentry-laravel)
[](https://discord.gg/cWnMQeA)
This is the official Laravel SDK for [Sentry](https://sentry.io).
## Getting Started
The installation steps below work on version 11.x of the Laravel framework.
For older Laravel versions and Lumen see:
- [Laravel 11.x](https://docs.sentry.io/platforms/php/guides/laravel/)
- [Laravel 8.x & 9.x & 10.x](https://docs.sentry.io/platforms/php/guides/laravel/other-versions/laravel8-10/)
- [Laravel 6.x & 7.x](https://docs.sentry.io/platforms/php/guides/laravel/other-versions/laravel6-7/)
- [Laravel 5.x](https://docs.sentry.io/platforms/php/guides/laravel/other-versions/laravel5/)
- [Laravel 4.x](https://docs.sentry.io/platforms/php/guides/laravel/other-versions/laravel4/)
- [Lumen](https://docs.sentry.io/platforms/php/guides/laravel/other-versions/lumen/)
### Install
Install the `sentry/sentry-laravel` package:
```bash
composer require sentry/sentry-laravel
```
Enable capturing unhandled exception to report to Sentry by making the following change to your `bootstrap/app.php`:
```php {filename:bootstrap/app.php}
withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
//
})
->withExceptions(function (Exceptions $exceptions) {
Integration::handles($exceptions);
})->create();
```
> Alternatively, you can configure Sentry as a [Laravel Log Channel](https://docs.sentry.io/platforms/php/guides/laravel/usage/#log-channels), allowing you to capture `info` and `debug` logs as well.
### Configure
Configure the Sentry DSN with this command:
```shell
php artisan sentry:publish --dsn=___PUBLIC_DSN___
```
It creates the config file (`config/sentry.php`) and adds the `DSN` to your `.env` file.
```shell {filename:.env}
SENTRY_LARAVEL_DSN=___PUBLIC_DSN___
```
### Usage
```php
use function Sentry\captureException;
try {
$this->functionThatMayFail();
} catch (\Throwable $exception) {
captureException($exception);
}
```
To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/php/guides/laravel/).
## Laravel Version Compatibility
The Laravel and Lumen versions listed below are all currently supported:
- Laravel `>= 11.x.x` on PHP `>= 8.2` is supported starting from `4.3.0`
- Laravel `>= 10.x.x` on PHP `>= 8.1` is supported starting from `3.2.0`
- Laravel `>= 9.x.x` on PHP `>= 8.0` is supported starting from `2.11.0`
- Laravel `>= 8.x.x` on PHP `>= 7.3` is supported starting from `1.9.0`
- Laravel `>= 7.x.x` on PHP `>= 7.2` is supported starting from `1.7.0`
- Laravel `>= 6.x.x` on PHP `>= 7.2` is supported starting from `1.2.0`
Please note that starting with version `>= 2.0.0` we require PHP Version `>= 7.2` because we are using our new [PHP SDK](https://github.com/getsentry/sentry-php) underneath.
The Laravel versions listed below were supported in previous versions of the Sentry SDK for Laravel:
- Laravel `<= 4.2.x` is supported until `0.8.x`
- Laravel `<= 5.7.x` on PHP `<= 7.0` is supported until `0.11.x`
- Laravel `>= 5.x.x` on PHP `>= 7.1` is supported until `2.14.x`
## Contributing to the SDK
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
## Getting Help/Support
If you need help setting up or configuring the Laravel SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
## Resources
- [](https://docs.sentry.io/quickstart/)
- [](https://discord.gg/Ww9hbqr)
- [](http://stackoverflow.com/questions/tagged/sentry)
- [](https://twitter.com/intent/follow?screen_name=getsentry)
## License
Licensed under the MIT license, see [`LICENSE`](LICENSE).