https://github.com/esign/laravel-sentry-throttling
https://github.com/esign/laravel-sentry-throttling
laravel php sentry throttle
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/esign/laravel-sentry-throttling
- Owner: esign
- License: mit
- Created: 2025-05-13T15:13:58.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-11-20T21:46:43.000Z (7 months ago)
- Last Synced: 2025-11-28T04:53:09.950Z (7 months ago)
- Topics: laravel, php, sentry, throttle
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Throttle exceptions being sent to Sentry
[](https://packagist.org/packages/esign/laravel-sentry-throttling)
[](https://packagist.org/packages/esign/laravel-sentry-throttling)
Laravel includes a built-in mechanism for throttling exceptions, but it doesn’t support defining throttling rules for individual reportables.
This package adds the ability to throttle exceptions specifically before they are sent to Sentry.
It's especially useful if you want to continue logging all exceptions locally while avoiding repeated reports of the same exception being sent to Sentry.
While Sentry does offer its own sampling via the sample_rate setting, that approach is percentage-based and less granular than exception-specific throttling.
## Installation
You can install the package via composer:
```bash
composer require esign/laravel-sentry-throttling
```
You must configure the `before_send` option in your `config/sentry.php` file so that Sentry uses the throttling logic.
Add the following to your Sentry config:
```php
// config/sentry.php
return [
// ...existing config...
'before_send' => [\Esign\SentryThrottling\SentryThrottling::class, 'beforeSend'],
];
```
## Usage
### Implementing throttling
The recommended way to use this package is to implement the `ThrottlesSentryReports` interface on your application's default exception handler (typically `App\Exceptions\Handler`):
```php
use App\Exceptions\ApiMonitoringException;
use Illuminate\Broadcasting\BroadcastException;
use Esign\SentryThrottling\Contracts\ThrottlesSentryReports;
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Support\Lottery;
use Throwable;
class Handler extends ExceptionHandler implements ThrottlesSentryReports
{
public function throttleSentry(Throwable $exception): Lottery | Limit | null
{
return match (true) {
$exception instanceof BroadcastException => Limit::perMinute(300),
$exception instanceof ApiMonitoringException => Lottery::odds(1, 1000),
default => Limit::none(),
};
}
}
```
Whilst we recommend implementing the `ThrottlesSentryReports` interface on your exception handler, you can implement it on any class you like.
### Binding the interface
You must bind your implementation of `ThrottlesSentryReports` in the Laravel container so the package can resolve it. This is typically done in a service provider, such as `App\Providers\AppServiceProvider`:
```php
use Esign\SentryThrottling\Contracts\ThrottlesSentryReports;
use App\Exceptions\Handler;
class AppServiceProvider extends ServiceProvider
{
public function register(): void
{
$this->app->bind(ThrottlesSentryReports::class, Handler::class);
}
}
```
### Testing
```bash
composer test
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.