evolution7/silverstripe-bugsnag-logger

Bugsnag error reporting integration for Silverstripe

1.0.2 2013-11-17 23:29 UTC

This package is not auto-updated.

Last update: 2024-02-26 23:03:10 UTC


README

The Silverstripe Bugsnag Logger sends your error notifications to Bugsnag.

Compatibility

Tested to work with both Silverstripe 2.4 and 3.x applications.

Installation

The recommended way is using Composer.

Add both this repository and the original bugsnag project to your project's composer.json file

"require": {
    "evolution7/silverstripe-bugsnag-logger": "1.*"
}

After this simply run

$ composer install

or

$ composer update evolution7/silverstripe-bugsnag-logger

As a submodule

Alternatively, if your project does not use Composer you can import the repository as a submodule.

$ git submodule add https://github.com/evolution7/silverstripe-bugsnag-logger bugsnag-logger
$ git submodule add https://github.com/bugsnag/bugsnag-php.git vendor/bugsnag
$ git submodule update --recursive --init

Usage

After installation, all you need to do is add the following line to your _config.php to enable the Bugsnag Logger.

E7_BugsnagLogger::enableWithApiKey(API-KEY-HERE);

Advanced Usage

Client configuration

Calling the enableWithApiKey method will return the Bugsnag_Client object from the official bugsnag-php library. To see what is possible with that, please see the documentation on their Github page.

Release stages

Bugsnag allows you to determine which release stage you are currently in, the Bugsnag Logger uses a ReleaseStage class for this which determines this based on the path, but it is possible to override this by providing your own ReleaseStage class as an optional second parameter when calling enableWithApiKey. This class will have to implement the ReleaseStageInterface to ensure it has the required methods.

E7_BugsnagLogger::enableWithApiKey(API-KEY-HERE, new CustomReleaseStage());

Contributing

  • Fork it on Github
  • Make the changes you'd like to see
  • Make a pull request
  • Thanks!