Devitek / laravel-correlational-id by CaporalDead

A package to add Correlational ID to Laravel
19
0
2
Package Data
Maintainer Username: CaporalDead
Maintainer Contact: thomas.sieffert@devitek.fr (Thomas Sieffert)
Package Create Date: 2016-07-18
Package Last Update: 2016-08-14
Language: PHP
License: MIT
Last Refreshed: 2024-05-18 03:15:51
Package Statistics
Total Downloads: 19
Monthly Downloads: 0
Daily Downloads: 0
Total Stars: 0
Total Watchers: 2
Total Forks: 0
Total Open Issues: 0

Add Correlational ID capability to Laravel

Latest Stable Version Total Downloads Latest Unstable Version License

Installing

composer require devitek/laravel-correlational-id

Add support to HTTP messages

Add this line to your app/Kernel.php file :

<?php

// ...

    protected $middleware = [
        CheckForMaintenanceMode::class,
        CorrelationalId::class,
        // ...
    ];

// ...

Add processor to Monolog

Add this line to your app/Kernel.php file :

<?php

// ...

    protected $middleware = [
        CheckForMaintenanceMode::class,
        CorrelationalId::class,
        CorrelationalIdMonolog::class,
        // ...
    ];

// ...

Add tag context to Sentry

Add this line to your app/Kernel.php file :

<?php

// ...

    protected $middleware = [
        CheckForMaintenanceMode::class,
        CorrelationalId::class,
        CorrelationalIdSentry::class,
        // ...
    ];

// ...

How it works ?

HTTP message

When your app receive an HTTP message it will try to read the X-Correlational-Id header from the request or generate a new one and add the same one to the response. It will also attach it as a request attribute.

Monolog

It will try to get the correlational ID from the request attributes and push a processor into monolog.

Sentry

It will try to get the correlational ID from the request attributes and add a tag context to the sentry client.

Enjoy it ! Feel free to fork :) !