https://github.com/adriaanzon/laravel-telescope-monitor
Exception monitoring via Laravel Telescope
https://github.com/adriaanzon/laravel-telescope-monitor
laravel-package
Last synced: 4 months ago
JSON representation
Exception monitoring via Laravel Telescope
- Host: GitHub
- URL: https://github.com/adriaanzon/laravel-telescope-monitor
- Owner: adriaanzon
- License: mit
- Created: 2022-03-11T20:13:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-20T11:52:25.000Z (4 months ago)
- Last Synced: 2025-03-20T12:16:56.515Z (4 months ago)
- Topics: laravel-package
- Language: PHP
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Telescope Monitor
**Exception monitoring via Laravel Telescope**
Laravel already allows you to get notified when something goes wrong in your application. You can, for example, log exceptions to the log file and to Slack by configuring a [log stack][] and setting it as your default log channel. However, one disadvantage is that subsequent occurrences of the same exception will also be logged, causing a flood of notifications when there is an exception that occurs frequently.
This package aims to solve that problem by logging the exceptions recorded by Telescope to a log channel. When an exception has already occurred before (according to the data stored by Telescope), it will not be logged again.
> [!TIP]
> Laravel 10 added support for [throttling reported exceptions][]. You should use that instead, if you're only interested in preventing floods of notifications.
By default, Telescope only logs failed jobs as an entry on the "Jobs" tab. This package additionally logs them as an exception entry so you will be notified of failed jobs as well. Note that when [manually failing a job][], it doesn't matter whether you call the [report()][] helper or not; the exception will be logged by the package either way. If you want to disable this behavior, you can do so by disabling `report_failed_jobs` in the configuration file.
## Installation
```shell
composer require adriaanzon/laravel-telescope-monitor
```
## Configuration
The log channel can be configured by adding `TELESCOPE_MONITOR_LOG_CHANNEL` to your dotenv file, for example:
```dotenv
TELESCOPE_MONITOR_LOG_CHANNEL=slack
```
In your local development environment, you'd typically disable Laravel Telescope Monitor by excluding `TELESCOPE_MONITOR_LOG_CHANNEL` from your .env file or setting it to null:
```dotenv
TELESCOPE_MONITOR_LOG_CHANNEL=null
```
To configure other options, you can publish the [configuration file][]:
```shell
php artisan vendor:publish --provider="AdriaanZon\TelescopeMonitor\TelescopeMonitorServiceProvider"
```
[log stack]: https://laravel.com/docs/12.x/logging#building-log-stacks
[configuration file]: config/telescope-monitor.php
[throttling reported exceptions]: https://laravel.com/docs/12.x/errors#throttling-reported-exceptions
[manually failing a job]: https://laravel.com/docs/12.x/queues#manually-failing-a-job
[report()]: https://laravel.com/docs/12.x/helpers#method-report