forecho/laravel-trace-log

trace log for laravel

v1.1.3 2022-08-11 03:08 UTC

Requires

• php: >=7.2

MIT

• forecho

README

Install

composer require forecho/laravel-trace-log

if you use Lumen, you need add service provider to your bootstrap/app.php file.

$app->register(Forecho\LaravelTraceLog\TraceLogServiceProvider::class);

Configuration

This step is optional

php artisan vendor:publish --provider="Forecho\LaravelTraceLog\TraceLogServiceProvider"

if you use Lumen, you need add config file to your config directory.

cp vendor/forecho/laravel-trace-log/config/tracelog.php config/

and you need add code to your bootstrap/app.php file.

$app->configure('tracelog');

Note

• The number of bits of the value corresponding to the key in log_filter_half_hide_keys must be greater than 2, otherwise all data is hidden.
• If the configuration file causes an error, the filtering function will be invalid, the error message can be searched for request_params_filter_key_config_error to view the log.

additional_fields is an array of additional fields that will be added to the log. eg:

'additional_fields' => [
    'user_id' => [App\Models\User::class, 'getId'],
    'tag' => 'test', // value can use closure、string、array
  ],

add getId() method to User model, and the value of the field will be the return value of the method.

namespace App\Models;

class User 
{
    public static function getId(): ?int
    {
        return data_get(Auth::user(), 'id');
    }
}

Usage

Middleware(Optional)

change App\Http\Kernel.php file to add TraceLogMiddleware middleware.

use Forecho\LaravelTraceLog\Middleware\TraceLogMiddleware;

protected $middlewareGroups = [
    // ...

    'api' => [
        // ...        
        'request.tracelog'
    ],
];


protected $routeMiddleware = [
    // ...    
    'request.tracelog' => TraceLogMiddleware::class
];

Logging

use Forecho\LaravelTraceLog\TraceLog;

TraceLog::warning('This is a warning message.', ['foo' => 'bar']);
TraceLog::error('This is an error message.', ['foo' => 'bar']);
TraceLog::info('This is an info message.', ['foo' => 'bar']);
TraceLog::debug('This is a debug message.', ['foo' => 'bar']);

Get Trace ID

use Forecho\LaravelTraceLog\TraceLog;

TraceLog::getTraceId();

Curl Request

if you want next system use the same trace_id, you need add trace_id to your header

use Forecho\LaravelTraceLog\TraceLog;

$key = config('tracelog.trace_id_header_key');
$headers = [
  $key => TraceLog::getTraceId(),
]