visualweber/error-handler-custom

A Error Handler for your ZF2 and ZF3 application to trap php errors & exceptions

1.0 2018-04-23 14:37 UTC

This package is auto-updated.

Last update: 2022-05-12 14:39:30 UTC


README

Introduction

ErrorHandlerCustom is a module for Error Logging (DB and Mail) your ZF2, ZF3 Mvc Application, and ZF Expressive for Exceptions in 'dispatch.error' or 'render.error' or during request and response, and PHP E_* Error.

Features

  • Save to DB with Db Writer Adapter.
  • Log Exception (dispatch.error and render.error) and PHP Errors in all events process.
  • Support excludes PHP E_* Error (eg: exclude E_USER_DEPRECATED) in config settings.
  • Support excludes PHP Exception (eg: Exception class or classes that extends it) in config settings.
  • Handle only once log error for same error per configured time range.
  • Set default page (web access) or default message (console access) for error if configured 'display_errors' = 0.
  • Set default content when request is XMLHttpRequest via 'ajax' configuration.
  • Provide request information ( http method, raw data, query data, files data, and cookie data ).
  • Send Mail
    • many receivers to listed configured email
    • with include $_FILES into attachments on upload error.

Installation

1. Import the following SQL for Mysql

DROP TABLE IF EXISTS `log`;

CREATE TABLE `log` (
  `id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT,
  `date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `type` int(11) NOT NULL,
  `event` text NOT NULL,
  `url` varchar(2000) NOT NULL,
  `file` varchar(2000) NOT NULL,
  `line` int(11) NOT NULL,
  `error_type` varchar(255) NOT NULL,
  `trace` text NULL,
  `request_data` text NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;

If you use other RDBMS, you may follow the log table structure above.

2. Setup your Zend\Db\Adapter\Adapter service or your Doctrine\ORM\EntityManager service config

You can use 'db' (with Zend\Db) config or 'doctrine' (with DoctrineORMModule) config that will be converted to be usable with Zend\Log\Writer\Db.

<?php
// config/autoload/local.php
return [
    'db' => [
        'username' => 'mysqluser',
        'password' => 'mysqlpassword',
        'driver'   => 'pdo_mysql',
        'database' => 'mysqldbname',
        'host'     => 'mysqlhost',
        'driver_options' => [
            \PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\'',
        ],
    ],
];

OR

<?php
// config/autoload/local.php
return [
    'doctrine' => [
        'connection' => [
            'orm_default' => [
                'driverClass' =>'Doctrine\DBAL\Driver\PDOMySql\Driver',
                'params' => [
                    'user'     => 'mysqluser',
                    'password' => 'mysqlpassword',
                    'dbname'   => 'mysqldbname',
                    'host'     => 'mysqlhost',
                    'port'     => '3306',
                    'driverOptions' => [
                        \PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\'',
                    ],
                ],
            ],
        ],
    ]
];

If you use other RDBMS, you may configure your own db or doctrine config.

3. Require this module uses composer.

composer require visualweber/error-handler-custom

4. Copy config

a. For ZF2/ZF3 Mvc application, copy error-handler-custom.local.php.dist config to your local's autoload and configure it

source destination
vendor/visualweber/error-handler-custom/config/error-handler-custom.local.php.dist config/autoload/error-handler-custom.local.php

Or run copy command:

cp vendor/visualweber/error-handler-custom/config/error-handler-custom.local.php.dist config/autoload/error-handler-custom.local.php

b. For ZF Expressive application, copy expressive-error-handler-custom.local.php.dist config to your local's autoload and configure it

source destination
vendor/visualweber/error-handler-custom/config/expressive-error-handler-custom.local.php.dist config/autoload/expressive-error-handler-custom.local.php

Or run copy command:

cp vendor/visualweber/error-handler-custom/config/expressive-error-handler-custom.local.php.dist config/autoload/expressive-error-handler-custom.local.php

When done, you can modify logger service named ErrorHandlerCustomLogger and error-handler-custom config in your's local config:

<?php
// config/autoload/error-handler-custom.local.php or config/autoload/expressive-error-handler-custom.local.php
return [

    'log' => [
        'ErrorHandlerCustomLogger' => [
            'writers' => [

                [
                    'name' => 'db',
                    'options' => [
                        'db'     => 'Zend\Db\Adapter\Adapter',
                        'table'  => 'log',
                        'column' => [
                            'timestamp' => 'date',
                            'priority'  => 'type',
                            'message'   => 'event',
                            'extra'     => [
                                'url'          => 'url',
                                'file'         => 'file',
                                'line'         => 'line',
                                'error_type'   => 'error_type',
                                'trace'        => 'trace',
                                'request_data' => 'request_data'
                            ],
                        ],
                    ],
                ],

            ],
        ],
    ],

    'error-handler-custom' => [
	// it's for the enable/disable the logger functionality
        'enable' => true,

        // default to true, if set to true, then you can see sample:
        // 1. /error-preview page ( ErrorHandlerCustom\Controller\ErrorPreviewController )
        // 2. error-preview command (ErrorHandlerCustom\Controller\ErrorPreviewConsoleController) via
        //       php public/index.php error-preview
        //
        // for zf-expressive ^1.0, the disable error-preview page is by unregister 'error-preview' from this config under "routes",
        // for zf-expressive ^2.0, the disable error-preview page is by unregister 'error-preview' from config/routes
        //
        //
        // otherwise(false), you can't see them, eg: on production env.
        'enable-error-preview-page' => true,

        'display-settings' => [

            // excluded php errors ( http://www.php.net/manual/en/errorfunc.constants.php )
            'exclude-php-errors' => [
                \E_USER_DEPRECATED,
            ],

            // excluded exceptions
            'exclude-exceptions' => [
                \App\Exception\MyException::class, // can be an Exception class or class extends Exception class
            ],

            // show or not error
            'display_errors'  => 0,

            // if enable and display_errors = 0, the page will bring layout and view
            'template' => [
                'layout' => 'layout/layout',
                'view'   => 'error-handler-custom/error-default'
            ],

            // if enable and display_errors = 0, the console will bring message
            'console' => [
                'message' => 'We have encountered a problem and we can not fulfill your request. An error report has been generated and sent to the support team and someone will attend to this problem urgently. Please try again later. Thank you for your patience.',
            ],
            // if enable, display_errors = 0, and request XMLHttpRequest
            // on this case, the "template" key will be ignored.
            'ajax' => [
                'message' => <<<json
{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Internal Server Error",
    "status": 500,
    "detail": "We have encountered a problem and we can not fulfill your request. An error report has been generated and sent to the support team and someone will attend to this problem urgently. Please try again later. Thank you for your patience."
}
json
            ],
        ],

        'logging-settings' => [
            // time range for same error, file, line, url, message to be re-logged
	        // in seconds range, 86400 means 1 day
            'same-error-log-time-range' => 86400,
        ],

        'email-notification-settings' => [
            // set to true to activate email notification on log error event
            'enable' => false,

            // Zend\Mail\Message instance registered at service manager
            'mail-message'   => 'YourMailMessageService',

            // Zend\Mail\Transport\TransportInterface instance registered at service manager
            'mail-transport' => 'YourMailTransportService',

            // email sender
            'email-from'    => 'Sender Name <sender@host.com>',

            'email-to-send' => [
                'developer1@foo.com',
                'developer2@foo.com',
            ],
        ],
    ],
    // ...
];

5. Lastly, enable it

a. For ZF Mvc application

// config/modules.config.php or config/application.config.php
return [
    'Application',
    'ErrorHandlerCustom', // <-- register here
],

b. For ZF Expressive application

You need to use Zend\ServiceManager for service container and Zend\View for template engine.

For zend-expressive-skeleton ^1.0, It's should already just works!

For zend-expressive-skeleton ^2.0, you need to open config/pipeline.php and add the ErrorHandlerCustom\Middleware\Expressive::class middleware after default ErrorHandler::class registration:

$app->pipe(ErrorHandler::class);
$app->pipe(ErrorHandlerCustom\Middleware\Expressive::class); // here

and also add error-preview routes in config/routes.php (optional) :

$app->get('/error-preview[/:action]', ErrorHandlerCustom\Middleware\Routed\Preview\ErrorPreviewAction::class, 'error-preview');

to enable error preview page. To disable error preview page, just remove it from routes.

Give it a try!

Web Access

URl Preview For
http://yourzfapp/error-preview Exception
http://yourzfapp/error-preview/error Error

You will get the following page if display_errors config is 0:

error preview in web

For production env, you can disable error-preview sample page with set ['error-handler-custom']['enable-error-preview-page'] to false.

Console Access

If you use zend-mvc v3, you need to have zendframework/zend-mvc-console in your vendor, if you don't have, you can install it via command:

composer require zendframework/zend-mvc-console --sort-packages
Command Preview For
php public/index.php error-preview Exception
php public/index.php error-preview error Error

You will get the following page if display_errors config is 0:

error preview in console

For production env, you can disable error-preview sample page with set ['error-handler-custom']['enable-error-preview-page'] to false.

For ZF Expressive, there is no default console implementation, so, if you want to apply it in your console in ZF Expressive, you may need to custom implementation error handler that utilize ErrorHandlerCustom\Handler\Logging service (see detailed usage at ErrorHandlerCustom\Middleware\Expressive class)

Contributing

Contributions are very welcome. Please read CONTRIBUTING.md