mindscapehq/raygun-cake

A CakePHP 2.x plugin for sending errors and exceptions to the Raygun.io service

v1.0.0 2018-11-27 20:01 UTC

Requires

• php: >=5.3.0
• mindscape/raygun4php: >=1.5.0

MIT

• Timm Stokke

• logging
• errors
• exceptions
• cakephp
• raygun

README

A CakePHP plugin to use Raygun.com for errors and exceptions. Required PHP 5.3+ (due to Raygun4php dependency)

Based on https://github.com/morrislaptop/AirbrakeCake

Dependencies

• CakePHP 2.x
• Raygun4php, bundled in /Vendor

Installation

git submodule add git://github.com/MindscapeHQ/RaygunCake.git app/Plugin/RaygunCake
cd app/Plugin/RaygunCake
git submodule init
git submodule update

app/Config/bootstrap.php

<?php
// Include our awesome error catcher..
CakePlugin::load('RaygunCake');
Configure::write('RaygunCake.apiKey', '<API KEY>');
// Optional: Send your application's version number
Configure::write('RaygunCake.version', '1.2.3.4');
// Optional: Filter out sensitive parameters before logging to Raygun
Configure::write('RaygunCake.filterParams', array('password' => true));
App::uses('RaygunError', 'RaygunCake.Lib');

app/Config/core.php

<?php
Configure::write('Error', array(
  'handler' => 'RaygunError::handleError',
  'level' => E_ALL & ~E_DEPRECATED,
  'trace' => true
));

Configure::write('Exception', array(
  'handler' => 'RaygunError::handleException',
  'renderer' => 'ExceptionRenderer',
  'log' => true
));

Manually register an error with Raygun

<?php
// Only the first 2 arguments are required
RaygunError::handleErrorRaygun(
  E_WARNING,
  "Generic Description",
  $file, $line, $tags,
  $userCustomData, $timestamp
);

Manually register an exception with Raygun

<?php
// Only the first argument is required
RaygunError::handleExceptionRaygun(
  $exception, $tags,
  $userCustomData, $timestamp
);