Exceptions To Stream plugin for Craft CMS 3.x

A small plugin to capture thrown exceptions (excluding status codes in the 400 range) to send to standard error stream

Icons by svgrepo.com & pngrepo.com

Usage

Exceptions

Exceptions thrown by craft will be handled automatically as this plugin listens to the Craft event ErrorHandler::EVENT_BEFORE_HANDLE_EXCEPTION. This plugin would treat an exception thrown by Craft as CRITICAL level which appears to best match for a generic purpose when handling ALL potential exceptions.

Monolog's description taken from RFC 5424 standard:

CRITICAL (500): Critical conditions. Example: Application component unavailable, unexpected exception.

Custom logging

For sending custom logs to the stream:

use madebyextreme\exceptionstostream\ExceptionsToStream;

public function bob()
{
    ExceptionsToStream::getInstance()->log->debug('message');
    ExceptionsToStream::getInstance()->log->info('message');
    ExceptionsToStream::getInstance()->log->notice('message');
    ExceptionsToStream::getInstance()->log->warning('message');
    ExceptionsToStream::getInstance()->log->error('message');
    ExceptionsToStream::getInstance()->log->critical('message');
    ExceptionsToStream::getInstance()->log->alert('message');
    ExceptionsToStream::getInstance()->log->emergency('message');
}

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project where your composer.json exists:

    cd /path/to/project
   

2. Updated composer.json:

    "repositories": [
      {
        "type": "vcs",
        "url": "https://github.com/extreme-creations/craft-exceptionstostream.git"
      }
    ]
   

3. Then tell Composer to load the plugin:

    composer require madebyextreme/exceptions-to-stream
   
    or
   
    docker-compose exec php bash -c "cd /var/www/site/craft/ && composer require madebyextreme/exceptions-to-stream"
   

4. In the Control Panel, go to Settings → Plugins and click the “Install” button for Exceptions To Stream, Or:

    ./craft plugin/install exceptions-to-stream
   
    or
   
    docker-compose exec php bash -c "cd /var/www/site/craft/ && ./craft plugin/install exceptions-to-stream"
   

Brought to you by Extreme