README

This is a full-featured client to add integration with Errbit (or Airbrake) to any PHP 8.2+ application.

PHP Version Requirements

Library Version	PHP Version
1.x	PHP 5.3
2.x	PHP 8.0, 8.1
3.x	PHP 8.2, 8.3, 8.4 (recommended)

Original idea and source has no support for php namespaces. Moreover it has a bug and with newest errbit version the xml has not supported chars.

What is for?

Handling your errors and passing them to the Error Retention tool called Errbit. It's a free alternative of sentry.io or airbrake.io. Check the presentation below!

Upgrading to v3.0

Version 3.0 contains breaking changes. If you're upgrading from v2.x, please note:

PHP 8.0 and 8.1 support has been dropped - Minimum PHP version is now 8.2
Removed ErrorInterface - Use \Throwable type hints instead
Changed WriterInterface::write() signature - Now accepts \Throwable instead of ErrorInterface
Updated error class constructors - Notice, Warning, Error, Fatal now use named parameters

ChangeLog

Check the:

Installation

Composer Way

For PHP 5.3

require: {
    "emgiezet/errbit-php": "1.*"
}

For PHP 8.0, 8.1

require: {
    "emgiezet/errbit-php": "2.*"
}

For PHP 8.2+ (recommended)

require: {
    "emgiezet/errbit-php": "^3.0"
}

Usage

To setup an Errbit instance you need to configure it with an array of parameters. Only two of them are mandatory.

use Errbit\Errbit;

Errbit::instance()
  ->configure(array(
    'api_key'           => 'YOUR API KEY',
    'host'              => 'YOUR ERRBIT HOST, OR api.airbrake.io FOR AIRBRAKE'
  ))
  ->start();

View the full configuration.

This will register error handlers:

set_error_handler();
set_exception_handler();
register_shutdown_function();

And log all the errors intercepted by handlers to your errbit.

If you want to notify an exception manually, you can call notify() without calling a start(). That way you can avoid registering the handlers.

use Errbit\Errbit;

try {
  somethingErrorProne();
} catch (Exception $e) {
  Errbit::instance()->notify(
    $e,
    array('controller'=>'UsersController', 'action'=>'show')
  );
}

Using your own error handler

If you don't want Errbit to install its own error handlers and prefer to use your own, you can just leave out the call to start(), then wherever you catch an Exception (note the errors must be converted to Exceptions), simply call

use Errbit\Errbit;
Errbit::instance()->notify($exception);

With this type of use. Library will not handle the errors collected by:

set_error_handler();
register_shutdown_function();

Using only some of the default handlers

There are three error handlers installed by Errbit: exception, error and fatal.

By default all three are used. If you want to use your own for some handlers, but not for others, pass the list into the start() method.

use Errbit\Errbit;
Errbit::instance()->start(array('error', 'fatal')); // using our own exception handler

Symfony Integration

Symfony 7

See the Symfony 7 integration guide for modern Symfony 7+ integration using PHP attributes and best practices.

Symfony 2

See the Symfony 2 documentation for legacy Symfony 2 integration.

Kohana 3.3 Integration

check out the kohana-errbit for kohana 3.3 integration.

Symfony 1.4 Integration

No namespaces in php 5.2 so this library can't be used. Go to filipc/sfErrbitPlugin and monitor your legacy 1.4 applications.

License & Copyright

Contributors

https://github.com/emgiezet/errbitPHP/graphs/contributors

Rest of the contributors: Author: emgiezet Contributors page

emgiezet / errbit-php

Maintainers

Details