Code Monkey home page Code Monkey logo

laravel-trace-log's Introduction

Trace Log for Laravel/Lumen

Latest Stable Version Latest Unstable Version Total Downloads License

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(),
]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.