Skip to content

adwiv/laravel-error-mailer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel ErrorLog Mailer

Package to report laravel errors by email with throttling and deduplication.

Installation

  1. Require this package with composer using the following command:
composer require adwiv/laravel-error-mailer
  1. Run the migration to create the error_logs table.
php artisan migrate
  1. Add the following keys to .env file
# Required Key
ERROR_MAILER_TO = "hello@example.com,admin@example.com" # Comma separated list of email addresses
# Optional Keys
ERROR_MAILER_FROM = "errors@example.com" # Mail sender, if not defined defaults to config setting
ERROR_MAILER_REPEAT_AFTER = 300   # Time in seconds for which same error will not be reported again
ERROR_MAILER_HOURLY_LIMIT = 10    # Maximum number of error mails that will be sent in an hour
  1. Configure config/logging.php. The package automatically adds a logging channel named error-mailer.

The simplest way to use it is to add it the stack channel.

    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single', 'error-mailer'], #<-- Add here
            'ignore_exceptions' => false,
        ],
        ...
     ],

Thats all. Any errors should now be reported to all the email addresses listed in ERROR_MAILER_TO environment option.

Troubleshooting

If mails are not being recieived, please check:

  1. Mail sending is configured correctly and you are able to send other mails without any issues.
  2. The ERROR_MAILER_TO variable is defined in .env file and has valid email addresses (without spaces)
  3. The mail queue is being processed correctly
  4. Check the laravel.log for any reported issues.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published