facile-it/sentry-module

This module allows integration of Sentry Client into laminas and mezzio

3.0.1 2022-04-27 11:45 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• laminas/laminas-servicemanager: ^3.4.0
• sentry/sentry: ^3.0.0

Requires (Dev)

• facile-it/facile-coding-standard: ^0.5.1
• friendsofphp/php-cs-fixer: ^3.0
• laminas/laminas-eventmanager: ^3.2.1
• laminas/laminas-log: ^2.12.0
• laminas/laminas-modulemanager: ^2.8.4
• laminas/laminas-mvc: ^3.1.1
• laminas/laminas-view: ^2.11.4
• lctrs/psalm-psr-container-plugin: ^1.6
• php-http/curl-client: ^2.1.0
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.0
• vimeo/psalm: ^4.22

Suggests

• laminas/laminas-eventmanager: Install to use the MVC error handler
• laminas/laminas-log: Install to use the log writer

Conflicts

• container-interop/container-interop: < 1.2
• laminas/laminas-eventmanager: < 2.6.2
• laminas/laminas-log: < 2.9
• laminas/laminas-modulemanager: < 2.5.1
• laminas/laminas-mvc: < 2.7
• laminas/laminas-view: < 2.5.1

MIT

• Thomas Vargiu

• log
• errors
• exceptions
• zend
• zf2
• exception
• error
• Zend Framework
• zf
• logs
• sentry
• raven
• zf3
• expressive
• laminas
• mezzio

README

This module allows integration with Sentry Client into laminas and mezzio.

Installation

The only supported way to install this module is trough composer. For composer documentation you can refer to getcomposer.org.

Install with implementations of php-http/async-client-implementation and psr/http-message-implementation:

php composer.phar require facile-it/sentry-module php-http/curl-client laminas/laminas-diactoros

Configuration

Client

To configure an instance of the client you can do as below:

return [
    'sentry' => [
        'disable_module' => false,
        'options' => [
            'dsn' => '',
            // other sentry options
            // https://docs.sentry.io/error-reporting/configuration/?platform=php
        ],
        'javascript' => [
            'inject_script' => false,
            'script' => [
                'src' => 'https://browser.sentry-cdn.com/5.6.3/bundle.min.js',
                'integrity' => 'sha384-/Cqa/8kaWn7emdqIBLk3AkFMAHBk0LObErtMhO+hr52CntkaurEnihPmqYj3uJho',
                'crossorigin' => 'anonymous',
            ],
            'options' => [
                'dsn' => '',
                // other sentry options
                // https://docs.sentry.io/error-reporting/configuration/?platform=php
            ],
        ],
    ],
];
//...

Now you can use the client and the Hub by retrieving it from the Service Locator.

use Sentry\HubInterface;

$hub = $this->getServiceLocator()->get(HubInterface::class);

Error Handler Listener

This module provides a listener for MvcEvent::EVENT_DISPATCH_ERROR and MvcEvent::EVENT_RENDER_ERROR events in order to log the exceptions caught in these events.

If you want to use it you should register it in your application module.

Example:

<?php

namespace App;

use Facile\SentryModule\Listener\ErrorHandlerListener;
use Laminas\Mvc\MvcEvent;

class Module 
{
    public function onBootstrap(MvcEvent $e): void
    {
        $application = $e->getApplication();
        $container = $application->getServiceManager();
        $eventManager = $application->getEventManager();
        
        /** @var ErrorHandlerListener $errorHandlerListener */
        $errorHandlerListener = $container->get(ErrorHandlerListener::class);
        $errorHandlerListener->attach($eventManager);
    }
}

Log Writer

You can use our log writer to write logs.

Example:

<?php

// global.php
return [
    'log' => [
        'application.log' => [
            'writers' => [
                [
                    'name' => \Facile\SentryModule\Log\Writer\Sentry::class,
                    'options' => [
                        'filters' => [
                            [
                                'name' => 'priority',
                                'options' => [
                                    'priority' => \Laminas\Log\Logger::ERR,
                                ],
                            ],
                        ],
                    ],
                ],
            ]
        ],
    ],
];

Usage:

$logger->crit('Log this message');

// or with exceptions, to see the correct trace in sentry:
$e = new \RuntimeException('test-exception');
$logger->crit($e->getMessage(), ['exception' => $e]);

Javascript

This module can inject the javascript Raven client library and configure it for you.

<?php

// facile-sentry.module.local.php
return [
    'sentry' => [
        'javascript' => [
            'inject_script' => true, // enable it
            'options' => [
                'dsn' => '',
                // other sentry options
                // https://docs.sentry.io/error-reporting/configuration/?platform=php
            ],
            // script options (defaults)
            'script' => [
                'src' => 'https://browser.sentry-cdn.com/5.6.3/bundle.min.js',
                'integrity' => 'sha384-/Cqa/8kaWn7emdqIBLk3AkFMAHBk0LObErtMhO+hr52CntkaurEnihPmqYj3uJho',
                'crossorigin' => 'anonymous',
            ],
        ],
    ],
];

In your layout:

<?= $this->headScript() ?>

Usage with Mezzio (ex zend-expressive)

If you want to use it with Mezzio you should initialize the Sentry client and Hub. You can simply retrieve the HubInterface service to initialize it.

use Sentry\HubInterface;

$container->get(HubInterface::class);