cristimark/logger-mezzio-module

A Logger for your Mezzio application to trap php errors & exceptions

dev-main 2020-12-10 21:22 UTC

This package is auto-updated.

Last update: 2022-01-10 23:43:02 UTC


README

This is README for version ^3.0 which only support Mezzio version 3 with php ^7.1. Introduction

LoggerMezzioModule is a module for Error Logging (DB and .txt file). Mezzio 3 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 or specific E_USER_DEPRECATED with specific message) in config settings.
  • Support excludes PHP Exception (eg: Exception class or classes that extends it or specific exception class with specific message) 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.
  • Set default content when there is no template service via 'no_template' configuration (Mezzio 3).
  • Provide request information ( http method, raw data, body data, query data, files data, cookie data, and ip address).
  • Send to a .txt log_error file is DB is not available

Installation

1. Import the following SQL for Mysql

DROP TABLE IF EXISTS `log_error`;

CREATE TABLE `log_error` (
  `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 Laminas\Db\Adapter\AdapterInterface service or your Doctrine\ORM\EntityManager service config

You can use 'db' (with Laminas\Db) config or 'doctrine' (with DoctrineORMModule) config that will be transformed to be usable with Laminas\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 cristimark/logger-mezzio-module

4. Copy config

Copy mezzio-error-module.local.php.dist config to your local's autoload and configure it

source destination
vendor/MarkVyrus/LoggerMezzioModule/config/mezzio-error-module.local.php.dist config/autoload/mezzio-error-module.local.php

Or run copy command:

cp vendor/MarkVyrus/LoggerMezzioModule/config/mezzio-error-module.local.php.dist config/autoload/mezzio-error-module.local.php

When done, you can modify logger service named LoggerMezzioModule and mezzio-error-module config in your's local config:

<?php
// config/autoload/mezzio-error-module.local.php

namespace Logger;

use Laminas\Db\Adapter\AdapterInterface;
use Laminas\Log;
use Logger\Middleware;

return [

    'log' => [
        'LoggerMezzioModule' => [
            'writers' => [

                [
                    'name' => 'db',
                    'options' => [
                        'db'     => AdapterInterface::class,
                        'table'  => 'log_error',
                        'column' => [
                            'timestamp' => 'data',
                            'priority'  => 'lvl',
                            'message'   => 'message',
                            'extra'     => [
                                //    'url'  => 'url',
                                'query' => 'query',
                                //    'line' => 'line',
                                //    'error_type' => 'error_type',
                                'trace' => 'stacktrace',
                                'request_data' => 'request_params',
                            ],
                        ],
                        'formatter' => [
                            'name' => 'db',
                            'options' => [
                                'dateTimeFormat' => 'Y-m-d H:i:s',
                            ],
                        ],
                    ],
                ],

            ],
        ],
    ],

    'logger' => [
        // it's for the enable/disable the logger functionality
        'enable' => true,
        'logpath' => 'data/log_error.txt',

        'display-settings' => [

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

                // can be specific error
                \E_USER_DEPRECATED,

                // can be specific error with specific message
                [\E_WARNING, 'specific error message'],

            ],

//            // excluded exceptions
//            'exclude-exceptions' => [
//
//                // can be an Exception class or class extends Exception class
//                \App\Exception\MyException::class,
//
//                // can be specific exception with specific message
//                [\RuntimeException::class, 'specific exception message'],
//
//                // or specific Error class with specific message
//                [\Error::class, 'specific error message'],
//
//            ],

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

            // if enable and display_errors = 0, the page will bring layout and view
            'template' => [
                // 'layout' config only when using Laminas View Template Engine
                'layout' => 'layout::default',
                'view' => 'logger::error-default'
            ],

            // for Mezzio, when container doesn't has \Mezzio\Template\TemplateRendererInterface service
            // if enable, and display_errors = 0, then show a message under no_template config
            'no_template' => [
                '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
            ],

            // 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
            'enable' => false,

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

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

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

            // to include or not $_FILES on send mail
            'include-files-to-attachments' => true,

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

    'dependencies' => [
        'abstract_factories' => [
            Log\LoggerAbstractServiceFactory::class,
        ],
        'factories' => [
            Middleware\Mezzio::class => Middleware\MezzioFactory::class,
            // ErrorHeroModule\Middleware\Routed\Preview\ErrorPreviewAction::class => InvokableFactory::class,

            Handler\Logging::class => Handler\LoggingFactory::class,
        ],
    ],

//    'templates' =>[
//        'paths' => [
//            'logger'    => [
//                realpath( dirname(dirname(__DIR__) ) . '/vendor/samsonasik/error-hero-module/view/error-hero-module' ),
//            ],
//        ],
//    ],

];

5. Lastly, enable it

For laminas-mezzio-skeleton ^3.0.0, you need to open config/pipeline.php and add the Logger\Middleware\Mezzio::class middleware after default ErrorHandler::class registration:

$app->pipe(ErrorHandler::class);
$app->pipe(Logger\Middleware\Mezzio::class); // here

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

// for use laminas-router
$app->get('/error-preview[/:action]', Logger\Middleware\Routed\Preview\ErrorPreviewAction::class, 'error-preview');

// for use FastRoute
$app->get('/error-preview[/{action}]', Logger\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://yourlaminasormezzioapp/error-preview Exception
http://yourlaminasormezzioapp/error-preview/error Error
http://yourlaminasormezzioapp/error-preview/notice PHP E_NOTICE
http://yourlaminasormezzioapp/error-preview/fatal PHP Fatal 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-module']['enable-error-preview-page'] to false.