creemedia/cakebrake4

CakePHP-4.x Airbrake plugin

1.0.2 2020-10-28 16:32 UTC

Requires

• php: >=7.2
• airbrake/phpbrake: ^0.7
• cakephp/cakephp: ^4.0

MIT

• Creemedia Team

README

CakePHP 4 Airbrake plugin

Inspiration

This packages is inspired by not maintained CakePHP 3 package hrisShick/AirbrakeCake

Requirements

This plugins has been developed for cakephp >=4.0 and PHP >=7.2

How do I get set up?

Add in Composer file:

composer require creemedia/cakebrake4

create <PROJECT_NAME>/config/airbrake_options.php

READ:

• https://airbrake.io/docs/api
• https://airbrake.io/docs/api/#create-deploy-v4

add options like:

return [
  'AirbrakeOptions' => [
    'project_id' => '<PROJECT_ID>',
    'project_api_key' => '<PROJECT_KEY>',
    // deploy config
    'environment' => '',
    'revision' => '',
    'username' => '',
    'repository' => '', // change to your own, example [https://github.com/airbrake/airbrake;]
    'revision' => '', // example exec('git rev-parse HEAD'),
  ]
];

You can add revision to track different versions of your application.

Application.php

Load plugin in bootstrap() method before call parent::bootstrap()

    public function bootstrap(): void
    {
        $this->addPlugin('Creemedia/CakeBrake4');

        // Call parent to load bootstrap from files.
        parent::bootstrap();
		// ...
	}

bootstrap.php

If you are loading the environment property in your airbrake_options.php from another config file, load airbrake_options afterwards.

	Configure::load('airbrake_options', 'default');

	$isCli = php_sapi_name() === 'cli';
	if ($isCli) {
		(new ConsoleErrorHandler(Configure::read('Error')))->register();
	} else {
		if (!Configure::read('debug')) {
			(new \Creemedia\CakeBrake4\Error\AirbrakeHandler(Configure::read('Error')))->register();
		} else {
			(new ErrorHandler(Configure::read('Error')))->register();
		}
	}

DeployTracking command.

	bin/cake airbrake_deploy_tracking

Contribution guidelines

• Writing tests
• Code review
• Other guidelines