tigerman55/sentry-delegator

Mezzio Delegator for Sentry

2.0 2020-12-29 14:21 UTC

Requires

• php: ^7.2
• laminas/laminas-dependency-plugin: ^1.0||^2.0
• laminas/laminas-servicemanager: ^3.4
• laminas/laminas-stratigility: ^3.1
• psr/container: ^1.0
• psr/http-message: ^1.0.1
• sentry/sdk: ^3.1

Requires (Dev)

• laminas/laminas-coding-standard: 2.0.0-alpha.3
• squizlabs/php_codesniffer: ^3.4
• webimpress/coding-standard: dev-master

BSD-3-Clause

• Joseph Koch

README

This is a mezzio delegator for the service Sentry utilizing Sentry's latest PHP SDK. The only required config is your Sentry project DSN. You can optionally add an environment, which will automatically be registered in your expressive application. Below is an example config.

return [
  'sentry' => [
    'dsn' => '[project dsn]',
    'environment' => '[environment]',
  ],
];

Installation

You can install SentryDelegator using Composer:

$ composer require tigerman55/sentry-delegator

Configuration

To bind your configuration to Sentry, you'll need to invoke the following somewhere early in your application. One option, is to put this in index.php right after the container initialization.

(new ConfigureSentry())($container->get('config'))

Advanced Usage

You can roll your own error listener by implementing ErrorListenerInterface. I've also created AsyncErrorListener to flush errors for asynchronous applications such as react-php and swoole. You can utilize this in your config.

Sentry context is supported with this delegator. To add context, simply add the following in the appropriate middleware:

Sentry\configureScope(function (Scope $scope) use ($context) : void {
    $scope->setUser([
        'email'    => $context['email'],
        'username' => $context['username'],
    ]);
});