README

A PHP module to make use of the Airbrake API for storing error messages. This is based loosely on the official Ruby implementation from the Airbrake team.

Installation

The best way to install the library is by using Composer. Add the following to composer.json in the root of your project:

{
  "require": {
    "brightlocal/php-airbrake": "dev-master"
  }
}

Then, on the command line:

curl -s http://getcomposer.org/installer | php
php composer.phar install

Use the generated vendor/autoload.php file to autoload the library classes.

Exception Handler Example

The preferred method for this to be used is via error and exception handlers, so that you do not have to manually call the configuration and client class every time. This is simply done by calling up the built in error handler and passing in your API key to its start() method like so:

<?php
require_once 'vendor/autoload.php';
Airbrake\EventHandler::start('[your api key]');

Optionally, you may pass a second parameter as TRUE to the start() method, in order to enable the logging of warning level messages as well. This is disabled by default, as it may considered too noisy, depending on the quality of the code base. There is also a third options array that may be passed, which will load many of the more common configuration options. These options are located below.

Basic Usage Example

If calling the class directly and not through an exception handler, it would be done like this:

<?php
require_once 'vendor/autoload.php';

$apiKey  = '[your api key]'; // This is required
$options = []; // This is optional

$config = new Airbrake\Configuration($apiKey, $options);
$client = new Airbrake\Client($config);

// Send just an error message
$client->notifyOnError('My error message');

// Send an exception that may have been generated or caught.
try {
    throw new Exception('This is my exception');

} catch (Exception $exception) {
    $client->notifyOnException($exception);
}

The options array may be filled with data from the Configuration Options section, if you would like to override some of the default options. Otherwise, it can be ignored.

Using Custom Notification Handlers

You can use external classes to handle non-standard handling of notifications, e.g. using asynchronous sending to avoid delays introduced by the need to make extra curl posts.

To use custom handler, create a class that implements Airbrake\Interfaces\NotificationHandler interface, and pass an instance to the config:

<?php
require_once 'vendor/autoload.php';

Airbrake\EventHandler::start(
    '[your api key]',
    true,
    [
        'notificationHandler' => new MyNotificationHandler(),
    ]
);

Configuration Options

timeout - Defaults to 2, this is how long the service will wait before giving up. This should be set to a sane limit, so as to avoid excessive page times in the event of a failure.
environmentName - Defaults to 'production'. This can be changed to match the environment that you are working, which will help prevent messy logs, filled with non-production problems.
serverData - This defaults to the $_SERVER array, but can be overridden with any array of data.
getData - Defaults to the $_GET array
postData - Defaults to the $_POST array
sessionData - Defaults to the $_SESSION array
component - This is the name of the component or controller that is running.
action - The name of the action that was called.
projectRoot - Defaults to the Document Root. May need to change based on the context of your application.
url - The main URL that was requested.
hostname - The hostname that was requested.
queue - Optional - the name of the Resque queue to use.
secure - Optional - Boolean that allows you to define if you want to hit the secure Airbrake endpoint.
notificationHandler - Optional - Instance of your custom Airbrake\Interfaces\NotificationHandler interface that will handle sending notifications.

brightlocal / php-airbrake

Maintainers

Details