hindsight/php-sdk

Monolog handler and Laravel package for Hindsight

v0.7 2018-08-19 16:55 UTC

Requires

• decahedron/monolog-sticky-context: ^1.0.0
• guzzlehttp/guzzle: ^6.3
• monolog/monolog: ^1.1.3
• ramsey/uuid: ^3.7

MIT

• Decahedron Technologies Ltd

README

Installation

1. composer require hindsight/php-sdk

On Laravel

1. php artisan vendor:publish --tag=hindsight
2. Insert your API key into the config/hindsight.php file and configure the remaining options to your liking
3. Add the \Hindsight\Middleware\HindsightRequestLogger::class middleware to the appropriate routes via app/Http/Kernel.php (to add it globally) or in the route files.

Laravel 5.6

On Laravel 5.6, register a new log channel with the hindsight driver:

    'channels' => [
        'stack' => [
            'driver' => 'stack',
            // Add hindsight to the stack:
            'channels' => ['single', 'hindsight'],
        ],

        // ...

        'hindsight' => [
            'driver' => 'hindsight',
        ],
    ],

Laravel < 5.6

If you are on Laravel 5.5, you don't need to do anything, we've automatically registered the service provider and the Hindsight logger.

If you are on Laravel 5.4 or earlier, add the Hindsight\Providers\HindsightServiceProvider::class to your config/app.php.

Without Laravel

If you are not using Laravel, you may manually configure your Monolog instance to start sending logs to Hindsight. For convenience, we have a configuration class that you may use:

use Hindsight\Hindsight;

Hindsight::setup($monologInstance, $yourApiKey);

If you wish to have a non-standard configuration, you may manually push the Hindsight\Monolog\HindsightMonologHandler onto your Monolog instance.