README.md

yassa-rollbar

 

This is ZF2 module that implements the notifier for Rollbar. Catches and reports exceptions to Rollbar.com for alerts, reporting, and analysis.

Requirements

• Zend Framework 2 (latest master)
• rollbar/rollbar-php

Installation

By cloning project

1. Install the rollbar-php by cloning it into ./vendor/.
2. Clone this project into your ./vendor/ directory.

With composer

1. Add this project in your composer.json:

   "require": {
       "yassa/rollbar": "dev-master"
   }

2. Install this package by running the command:

   $ php composer.phar update

Post installation

1. Enabling it in your application.config.phpfile.

   <?php
   return array(
       'modules' => array(
           'Yassa\Rollbar', // must be added as the first module
           // ...
       ),
       // ...
   );

2. Copy config/module.yassa.rollbar.global.php.dist in project/directory/config/autoload/ and remove .dist extension.

Options

The following options are available:

• enabled - Switch On/Off module
• access_token - Your project access token
• base_api_url - The base API url to post to. (default: https://api.rollbar.com/api/1/)
• batch_size - Flush batch early if it reaches this size (to prevent memory issues). (default: 50)
• batched - true to batch reports from a single request together. (default: true)
• branch - Name of the checked-out branch.
• capture_error_stacktraces - Record full stacktraces for PHP errors. (default: true)
• environment - Environment name. Any string up to 255 chars is OK. For best results, use "production" for your production environment. (default: production)
• error_sample_rates - Associative array mapping PHP error numbers to sample rates. Sample rates are ratio out of 1, e.g. 0 is "never report", 1 is "always report", and 0.1 is "report 10% of the time". Sampling is done on a per-error basis. (default: array(), meaning all errors are reported.)
• errorhandler - Register Rollbar as an error handler to log PHP errors
• exceptionhandler - Register Rollbar as an exception handler to log PHP exceptions
• host - Server hostname. (default: null, which will defer to a call to gethostname() (or php_uname('n') if that function does not exist))
• logger - An object with a log($level, $message) method. Will be used by RollbarNotifier to log messages.
• max_errno - Max PHP error number to report. e.g. 1024 will ignore all errors E_USER_NOTICE or higher. (default: -1 (report all errors))
• person - An associative array describing the currently-logged-in user. Required: id, optional: username, email. All values are strings.
• person_fn - A function reference (string, etc. - anything that call_user_func can handle) returning an array like the one for 'person'
• root - Absolute path to the root of your application, not including the final /.
• scrub_fields - Array of field names to scrub out of POST. Values will be replaced with astrickses. If overridiing, make sure to list all fields you want to scrub, not just fields you want to add to the default. Param names are converted to lowercase before comparing against the scrub list. (default: array('passwd', 'password', 'secret', 'confirm_password', 'password_confirmation'))
• shift_function - Whether to shift function names in stack traces down one frame, so that the function name correctly reflects the context of each frame. (default: true)
• shutdownfunction - Register Rollbar as an shutdown function
• timeout - Request timeout for posting to Rollbar, in seconds. (default: 3)