How can I get email notifications for exceptions?

Question

How do I setup email notifications for exceptions that are either logged or thrown on the site?

UPDATE: A few people have commented on the fact that you may expect to get way too many emails if you have every exception emailed to you. I tend to like to keep my exception log pretty light. Anything that goes in there I view as, well, an exception. If it's expected functionality and not a problem, then I like to catch the exception, possibly log it to another file (maybe system.log) if needed, but not log it to exception.log.

But if you have a lot of noise in your exception.log that you don't want to clean, you're likely not going to want to do this.

Answer 1

You can use the Magento Hackthon Logger for this job: https://github.com/firegento/firegento-logger/

It is not the question, but there are extensions for the extension: https://github.com/magento-hackathon/LoggerSentry/

What I want to say: It is easy to implement your own "Writer" :-)

Answer 2

This didn't seem as readily accessible as I thought it should be from some searching I did, so I'm posting up a question question/answer for future reference.

Thrown Exceptions

You can enable email notifications for exceptions that are thrown using errors/local.xml. You can copy your errors/local.xml.template to `errors/local.xml' and drop in the email address and subject line that you want to use.

<config>
    <skin>default</skin>
    <report>
        <action>email</action>
        <subject>domain.com exception</subject>
        <email_address>[email protected]</email_address>
        <trash>leave</trash>
    </report>
</config>

Then, if any exceptions are thrown and caught by Magento's error handling system, where an error report screen is displayed to the end user, you'll get an email notification.

Logged Exceptions

If you would also like to get email notifications for exceptions that aren't thrown but rather are logged, you'll need to get a little bit further under the hood.

First, override the core log writer class.

Once you've done that, just drop in the code to shoot yourself an email after the exception is logged. Remember that you need to save the log filename from within the __construct() in order to have access to it from the _write() method.

class Module_Core_Model_Zend_Log_Writer_Stream extends Zend_Log_Writer_Stream
{
    protected $_streamOrUrl;

    public function __construct($streamOrUrl, $mode = NULL)
    {
        parent::__construct($streamOrUrl, $mode);

        $this->_streamOrUrl = $streamOrUrl;
    }

    protected function _write($event)
    {
        parent::_write($event);

        if (strpos($this->_streamOrUrl, 'exception.log') === false) {
            return;
        }

        // Send email here    
    }
}

Answer 3

Emailing every exception will probably result in a LOT of mail.

It might be a better option to just log the exceptions to the exception log and mail that once a day to yourself using a cronjob in linux

0 23 * * * /usr/lib/sendmail [email protected] < /home/shop.com/www/var/log/exception.log

And optionally cleaning it up after you've mailed it

0 23 * * * /usr/lib/sendmail [email protected] < /home/shop.com/www/var/log/exception.log;rm /home/shop.com/www/var/log/exception.log

Or you could execute it every hour if you need a higher frequency.

This way there is no need to overwrite any files and keeping the load on the server that constantly sending mails to yourself down.

Answer 4

maybe you can also be interested in my Magento/Monolog integration

https://github.com/aleron75/magemonolog

Regards Alessandro

Answer 5

I dont like the implementation of Mage::log's custom writerModel or I dont understand it. For me it does not take advantage of Zend_Log design to enable n writers. I would have taken a Log not a Writer. Therefore I made a workaround to take the full advantage of the Zend_Log and still write not much code, since I aggregate a Zend_log.

class XX_XXX_Model_Log extends Zend_Log_Writer_Abstract{

/**
 * @var Zend_Log
 */
protected $zendLog = array();

/**
 *
 * @param  mixed $writer Zend_Log_Writer_Abstract or Config array
 * @return void
 */
public function addWriter($writer)
{
    return $this->zendLog->addWriter($writer);
}

/**
 * Write a message to the log.
 *
 * @param  array  $event  log data event
 * @return void
 */
protected function _write($event){
    $this->zendLog->log($event['message'], $event['priority']);
}

/**
 * Konstruktor erweitert Log automatisch um Writer
 *
 * @param sting $file
 */
public function __construct($file){
    $this->zendLog = new Zend_Log();
    $this->enhance($file);
}

/**
 * Hier werden die Writer and Zend_Log angehangen
 *
 * @param sting $file
 */
public function enhance($file){
    /* put your custom Logger here - example firePHP*/
        $writer = Mage::getModel('gdcore/firephp');
        $writer->addFilter(Zend_Log::Debug);
        $this->addWriter($writer);
    }
}

/**
 * Construct a Zend_Log driver
 * 
 * @param  array|Zen_Config $config
 * @return Zend_Log_FactoryInterface
 */
static public function factory($config){
    return Zend_Log::factory($config);
}
}

By the way in Magento 1.7 I get just a few emails. Each email has some exceptions/errors for one request, I guess. So highly frequented site will still result in many email. I will have look on that. By now its okay for me.

Answer 6

You also could use a module to create email notifications or get daily reports of customers which got exceptions:

Here is explained the implementation: https://grafzahl-io.blogspot.de/2017/03/notifications-for-every-exception-in-magento.html

This is the module to monitor errors and other events (even apply a discount to the customer if he got an exception): https://grafzahl.io/notify-module