Download the PHP package vikasrinvi/laravel-bug-watcher without Composer
On this page you can find all versions of the php package vikasrinvi/laravel-bug-watcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vikasrinvi/laravel-bug-watcher
More information about vikasrinvi/laravel-bug-watcher
Files in vikasrinvi/laravel-bug-watcher
Package laravel-bug-watcher
Short Description to send the mail when error occured
License
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-bug-watcher
laravel-bug-watcher
This is package is made for the developer. It sends the error message in email whenever there is any bug in the application and also create a clickup task in the clickup.
Features
- Send Email with the details of the bug.
- Create a task in the clickUp with bug report
Future Scope
- Can be integrated with the AI like chatgpt to which can provide the optimum solution for the bug.
- We can store the error log and create a UI with some route so that all the previous bug on the system can be tracked
Requirements
- PHP >= 8.1
- Laravel >= 9.0
Installation
Run the following command
After updating composer, add the service provider to the providers array in config/app.php
you can skip adding the provider to config/app.php as it will be auto-discovered
Then in app/Exceptions/Handler.php replace
with
Configuration
To publish the config file
That will create a config file for you in config/laravel-bug-watcher.php
Default configuration:
Basic Usage
Basic Config of clickup task
- createTask (bool) - Enable or disable creating task in the clickup.
- token (string) - Token from the clickup
- Team name (string) - Team name is the team in which the project is created we need to get it from the click, it it also the workspace name
- Folder name (string) - This is the project name in the click up
- list name - It is task parent of the task under which task will be created in the clickup Important: There should be a Status under the list call 'BACKLOG' and ther should a label create with the name 'bug.
Basic Config of email
- email (bool) - Enable or disable emailing of errors/exceptions
- dontEmail (array) - This works exactly like laravel's $dontReport variable documented here: https://laravel.com/docs/10.x/errors]#the-exception-handler under Ignoring Exceptions By Type. Keep in mind also any exceptions under laravel's $dontReport also will not be emailed
- throttle (bool) - Enable or disable throttling of exception emails. Throttling is only performed if its been determined the exact same exception/error has already been emailed by checking the cache. Errors/Exceptions are determined to be unique by exception class + exception message + exception code
- throttleCacheDriver (string) - The cache driver to use for throttling, by default it uses CACHE_DRIVER from your env file
- throttleDurationMinutes (int) - The duration in minutes of the throttle for example if you put 5 and a BadMethodCallException triggers an email if that same exception is thrown again it will not be emailed until 5 minutes have passed
- dontThrottle (array) - This is the same as dontEmail except provide a list of exceptions you do not wish to throttle ever even if throttling is turned on
- globalThrottle (bool) - Enable or disable whether you want to globally throttle the number of emails you can receive of all exception types by this application
- globalThrottleLimit (int) - The the maximum number of emails you want to receive in a given period.
- throttleDurationMinutes (int) - The duration in minutes of the global throttle for example if you put in 30 and have 10 for your globalThrottleLimit when the first email is sent out a 30 minute timer will commence once you reach the 10 email threshold no more emails will go out for that 30 minute period.
- toEmailAddress (string|array) - The email(s) to send the exceptions emails to such as the dev team [email protected]
-
fromEmailAddress (string) - The email address these emails should be sent from such as [email protected].
- emailSubject (string) - The subject of email, leave NULL to use default Default Subject: Error Occured config('app.name', 'unknown').' ('.config('app.env', 'unknown').')'
Note: the dontReport variable from app/Exceptions/Handler.php file will also not be emailed as it's assumed if they are not important enough to log then they also are not important enough to email
Important: You must fill out a toEmailAddress and fromEmailAddress or you will not receive emails.
Advanced Usage
Changing the view
If you published your view using the command below you will be able to change the look of the exception email by modifying your view in resources/views/vendor/laravel-bug-watcher/emailException.blade.php follow this to publish the view and the you can modify it
Important notes
Make sure you have configured your Mail setting in the env so that Mail can be send
