#Fork changes The forked project is compatible with old Sentry version (<= 4.7.8)

#Description A Zend Framework 2 module that lets you log exceptions, errors or whatever you wish to the Sentry service.

ZendSentry is released under the New BSD License.

The current version of ZendSentry is 0.3.1. We consider it a good beta, we've been using it in production for a couple months.

#Important Changes

• 0.3.1: dedicated CLI ExceptionStrategy (credits to Mateusz Mirosławski)
• 0.2.1: bug fix release (partial credits to Paweł Skotnicki)
• 0.2.0: added master switch to turn everything on/off, log context can be passed as object or string (new)
• 0.1.2: contains a critical dependency upgrade, the raven library used curl methods that are not yet available in many linux distributions. If you experience problems with curl, upgrade!

#Introduction

##What's Sentry? Sentry is an online service to which you can log anything including your exceptions and errors. Sentry creates nice reports in real time and aggregates your logged data for you.

##What's ZendSentry It is a module that builds the bridge between your Zend Framework 2 application and the Sentry service. It's extremely easy to setup and does a lot of things out-of-the-box.

Current features:

• log PHP exceptions to Sentry
• log PHP errors to Sentry
• log uncaught Javascript errors to Sentry
• log anything to Sentry by triggering a registered log listener

#Installation

This module is available on Packagist. In your project's composer.json use:

{   
    "require": {
        "marden/zend-sentry": "0.3.1"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/marden/zend-sentry"
        }
    ]
}

Run php composer.phar update to download it into your vendor folder and setup autoloading.

Now copy zend-sentry.local.php.dist to yourapp/config/autoload/zend-sentry.local.php and add your Sentry API key. Then copy zend-sentry.global.php.dist to the same place, also removing .dist. Adjust settings, if needed.

Add ZendSentry to the modules array in your application.config.php, preferably as the first module.

That's it. There's nothing more you need to do, everything works at that stage, try it. Happy logging!

#Usage

Again, you don't need to write a single line of code to make this work. The default settings will make sure Sentry is registered as both error and exception handler, try it by triggering and error or throwing around some exceptions. You should instantly see them in your Sentry dashboard. ZendSentry also packages its own ExceptionStrategy to make sure, exceptions ZF would otherwise intercept, are logged.

Additonally, the module registers a log event listener on application level. So you can trigger custom log events from anywhere in your application. These will be logged using the Zend\Log\Logger with a Sentry writter provided by this mdule.

In a controller, you may do:

$this->getEventManager()->trigger('log', $this, array(
    'priority' => \Zend\Log\Logger::INFO, 
    'message' => 'I am a message and I have been logged'
));

Make sure to pass "log" as the first parameter and $this or a custom context string as second parameter. Keep this consistent as Sentry will use this for grouping your log entries. As the third parameter, you want to pass an array with a priority key and a message key. It's best to use the priorities provided by the framework. They will be mapped onto Sentry's own priorities.

#Configuration options

Just for the record, a copy of the actual global configuration options:

/**
 * Turn ZendSentry off or on as a whole package
 */
'use-module' => true,

/**
 * Attach a generic logger event listener so you can log custom messages from anywhere in your app
 */
'attach-log-listener' => true,

/**
 * Register the Sentry logger as PHP error handler
 */
'handle-errors' => true,

/**
 * Should the previously registered error handler be called as well?
 */
'call-existing-error-handler' => true,

/**
 * Register Sentry as shutdown error handler
 */
'handle-shutdown-errors' => true,

/**
 * Register the Sentry logger as PHP exception handler
 */
'handle-exceptions' => true,

/**
 * Should the previously registered exception handler be called as well
 */
'call-existing-exception-handler' => true,

/**
 * Should exceptions be displayed on the screen?
 */
'display-exceptions' => false,

/**
 * Should Sentry also log javascript errors?
 */
'handle-javascript-errors' => true,

#Try it A few ideas how to try the different features from a Controller:

// Test logging of PHP errors
// trigger_error('can I trigger an error from a controller');

// Test logging of PHP exceptions
// throw new \Exception('Some exception gets logged.');

// Throw a javascript error and see it logged
// $headScript = $this->getServiceLocator()->get('viewhelpermanager')->get('headscript')
                      ->appendScript("throw new Error('A javascript error should be logged.');");