Skip to content

Latest commit

 

History

History
276 lines (199 loc) · 9.24 KB

README.md

File metadata and controls

276 lines (199 loc) · 9.24 KB
Raw
Kraken Client Logo

Last version Php version

kRAKEN is an application for tracking and managing errors issued by external applications

This library provides a PHP client API to facilitate calls to kRAKEN and an integration for the Laravel and Phalcon frameworks

The integrations add an ExceptionHandler, which carries out a complete report of unhandled exceptions and a Logger, which allows you to use the kRAKEN system for receiving and archiving log messages

Table of Contents

Get Started

Requires PHP 8.1+

First, install Kraken Client via the Composer package manager:

composer require shellrent/kraken-client

Then interact with kRAKEN's API to send a report:

$report = new \Shellrent\KrakenClient\ReportBuilder( 
  'report-type', //Corresponds to the type code configured on the project on kRAKEN app
  'message' //Message to send
);

$client = new \Shellrent\KrakenClient\KrakenClient( 
  'https://kraken-endpoint.com', //kRAKEN endpoint 
  'auth-token' //Create an "environment" on the project page on kRAKEN app
);

$client->sendReport( $report->getData() );

To generate a standard report starting from an exception, simply use the specific ReportBuilder method:

try {
    /* code that throws an exception */
    
} catch( Exception $exception ) {
    $report = new \Shellrent\KrakenClient\ReportBuilder::createFromException( $exception );
    
    /* send the report */
}

Laravel

Requires Laravel 10.x

ExceptionHandler also works with Laravel 9.x

Previous or later versions have not yet been tested

use on other versions is possible at your own risk

There is an integration with the Laravel framework

The Laravel package provides an ExceptionHandler and registers the client API and a psr style logger in the service container

Integration (Laravel)

To make the package work, you need to add the following settings to the .env file:

KRAKEN_ENDPOINT="https://kraken-endpoint.com"
KRAKEN_AUTH_TOKEN="auth-token"

To be able to send reports via queue you must specify the name of the queue to use in the .env file, you can use the "default" value to use the standard queue

KRAKEN_QUEUE_NAME="default"

It is possible to test the connection to kraken and that the configurations are correct, using the command:

php artisan kraken:test

ExceptionHandler Usage (Laravel)

To enable exception reporting via the Exception Handler, you need to set the ExceptionHandler in the file bootrstrap/app.php, overriding the current configuration:

$app->singleton(
    Illuminate\Contracts\Debug\ExceptionHandler::class,
    \Shellrent\KrakenClient\Laravel\KrakenExceptionHandler::class
);

It is possible to decide on which environments to activate the sending of reports by modifying enabled_envs in the config file; by default only the production environment is enabled

By default the package does not send the information of the logged in user, they can be added by setting user_report_builder in the configuration file, with a callable that returns this information

For more details see laravel customization

Logger Usage (Laravel)

It is possible to send single reports and logs via KrakenLogger using its Facade:

use Shellrent\KrakenClient\Laravel\Facades\KrakenLogger;

KrakenLogger::debug( 'message' );
KrakenLogger::info( 'message' );
KrakenLogger::notice( 'message' );
KrakenLogger::warning( 'message' );
KrakenLogger::error( 'message' );
KrakenLogger::critical( 'message' );
KrakenLogger::alert( 'message' );
KrakenLogger::emergency( 'message' );

Instead, to use kraken through the Laravel logging system, you can add kraken as a custom channel in the config/logging.php configuration file

It can also be added to the stack channel along with other channels

/******/
'channels' => [
    /*****/
        'stack' => [
            'driver' => 'stack',
            'channels' => ['daily', 'kraken'],
            'ignore_exceptions' => false,
        ],
        /*****/
        'kraken' => [
            'driver' => 'kraken',
            'level' => env('LOG_LEVEL', 'debug'),
            'report_exceptions' => false,
        ],
    /*****/
]

The kraken log channel can be used as a replacement for the ExceptionHandler, simply set 'report_exceptions' => true in the configuration

WARNING

Use the ExceptionHandler and the log channel with set 'report_exceptions' => true at the same times, duplicates the reports sent in case of an exception

Customization (Laravel)

To be able to modify the configuration you must first publish it via the command:

php artisan vendor:publish --provider="Shellrent\KrakenClient\Laravel\KrakenServiceProvider"

From the file created in config/kraken.php you can edit:

  • The code of the standard modules used by the framework
  • The environments that trigger the ExceptionHandler
  • The type code and builder class of an exception report
  • The type code and builder class of an log report
  • Signed in user information

For more details see the configuration file

Phalcon

Requires Phalcon 5.1

Previous or later versions have not yet been tested

use on other versions is possible at your own risk

There is an integration with the Phalcon framework

The integration with Phalcon provides an ExceptionHandler and allows you to obtain the configuration and a psr style logger via the DI container of the framework

Integration (Phalcon)

To make the package work, you need to add the following settings to the .env file:

KRAKEN_API_ENDPOINT="https://kraken-endpoint.com"
KRAKEN_API_TOKEN="auth-token"

ExceptionHandler Usage (Phalcon)

To send exception reports it is necessary to integrate the ExceptionHandler provided in the phalcon package with the one used by the application

It is possible to decide on which environments to activate the sending of reports, passing the collections of environments to the ExceptionHandler. By default the activated environment is production

$envs = ['production'];
$krakenHandler = \Shellrent\KrakenClient\Phalcon\KrakenExceptionHandler::create( $envs )
$krakenHandler->report( $exception, $errno, $errstr, $errfile, $errline, $backtrace );

The handler handles both exceptions and php errors

You can add session parts to the report via the addSessionKey method

$krakenHandler->addSessionKey( 'logged-used' );

Furthermore, it is possible to hide specific information in the report by passing the key or the value that identifies it. Useful if sensitive data is present in $_SERVER or other collections

$krakenHandler->addHideDataKey( getenv( 'DATABASE_PASSWORD' ) );
$krakenHandler->addHideDataKey( 'KEY_CLI_ACCESS' );

By default the package does not send the information of the logged in user, they can be added by setting userDataGetter property in the configuration object, with a callable that returns this information

For more details see phalcon customization

Logger Usage (Phalcon)

It is possible to send single reports and logs via KrakenLogger using KrakenService:

$logger = \Shellrent\KrakenClient\Phalcon\KrakenService::logger();

$logger->debug( 'message' );
$logger->info( 'message' );
$logger->notice( 'message' );
$logger->warning( 'message' );
$logger->error( 'message' );
$logger->critical( 'message' );
$logger->alert( 'message' );
$logger->emergency( 'message' );

Customization (Phalcon)

It is not necessary for correct working, but in order to customize the behavior of the package, the services need to be registered in the DI

abstract class GenericApplication {
  /******/
  
  private function registerServices() {
      /******/
      $config = \Shellrent\KrakenClient\Phalcon\Config\Config::default();
      \Shellrent\KrakenClient\Phalcon\KrakenService::create( $config )->inject( $this->Di );
  } 
}

The config object can be customized for change:

  • The type code and builder class of an exception report
  • The builder class of an php error report
  • The type code and builder class of an log report
  • Signed in user information

For more details see the configuration class