README

laravel日志中间件

Requirements

php: ^7.2
laravel: ^6.0

Installation

composer require zdz/laravel-middleware-log

Usage

注册中间件(选择合适的)

全局注册

在 app/Http/Kernel.php 中的 $middleware 属性中列出这个中间件

// 在 App\Http\Kernel 类中...

protected $middleware = [
    \App\Http\Middleware\TrustProxies::class,
    \App\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    // 日志中间件
    \zdz\LaravelMiddlewareLog\WriteLogMiddleware::class,
];

中间件组 (推荐,只记录api日志)

// 在 App\Http\Kernel 类中...

protected $middlewareGroups = [
        'web' => [
            \App\Http\Middleware\EncryptCookies::class,
            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
            \Illuminate\Session\Middleware\StartSession::class,
            // \Illuminate\Session\Middleware\AuthenticateSession::class,
            \Illuminate\View\Middleware\ShareErrorsFromSession::class,
            \App\Http\Middleware\VerifyCsrfToken::class,
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
        ],

        'api' => [
            'throttle:60,1',
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
            // 日志中间件
            \zdz\LaravelMiddlewareLog\WriteLogMiddleware::class,
        ],
    ];

单独路由

// 在 App\Http\Kernel 类中...
protected $routeMiddleware = [
    'auto_log' => \zdz\LaravelMiddlewareLog\WriteLogMiddleware::class,
];

Route::get('admin/profile', function () {
    //
})->middleware('auto_log');

监听sql语句

// 在 App\Providers\EventServiceProvider 类中...
protected $listen = [
    Registered::class => [
        SendEmailVerificationNotification::class,
    ],
   // 添加sql监听 
    \Illuminate\Database\Events\QueryExecuted::class => [
        \zdz\LaravelMiddlewareLog\SqlLogListen::class
    ]
];

Log结构

默认请求一次，记录一条日志，日志为json字符串，结构如下：

字段	描述
message	默认为auto-log，修改config里的log_message自定义
level	laravel日志级别
level_name	laravel日志级别名称
channel
datetime	记录时间
extra
context	日志内容，修改config里的log_fields自定义默认记录字段
\|- exec_exception	程序运行抛出的异常（内置，不可修改）
\|- exec_ms	执行时间，依赖于常量`LARAVEL_START`, 没有则可以在`public/index.php`添加 `define('LARAVEL_START', microtime(true));`（内置，不可修改）
\|- time	内置记录时间，格式：Y-m-d H:i:s
\|- full_url	完整路由
\|- path_info	请求路由
\|- client_ip	客户端ip
\|- request_method	请求方法
\|- request_header	请求header
\|- request_params	请求参数
\|- response_header	响应header
\|- response_body	响应结果
\|- db_sql	sql语句数组(需监听sql语句)
\|-- connection_name	连接名称
\|-- sql	sql语句
\|-- bindings	绑定参数
\|-- ms	sql执行时间

Configuration（可选，自定义配置）

使用以下命令发布配置，发布之后会生成config/log-middleware.php，在此文件里修改配置

php artisan vendor:publish --provider="zdz\LaravelMiddlewareLog\LogServiceProvider"

config/log-middleware.php

字段	类型	描述	示例
exclude_route	array	忽略的路由,在此数组中则不会记录日志,支持通配符`*`	['api/log/test', 'web/*']
exclude_route_fields	array	忽略的路由字段，记录路由日志，但不记录字段里的值,支持通配符`*`	['api/log/*' => [ 'response_body' ] ]
exclude_exception	array	忽略的异常类，如果是此异常则不记录到exec_exception	默认忽略 [Illuminate\Validation\ValidationException::class,]
exclude_exception_fields	array	用于抛出异常时，字段内容置为空	默认： [ 'response_body' ]
log_fields	array	记录的数据，可自定义，形式： key => [ 类（request、response）, 方法，属性 ]	有以下三种情况： 1. 'full_url' => [ 'request', 'fullUrl' ] = $request->fullUrl() 2. 'response_header' => [ 'response', 'all', 'headers' ] = $response->headers->all() 3. 'response_header' => [ 'response', '', 'headers' ] = $response->headers
log_message	string	日志消息	默认：auto-log
log_level	string	日志级别: debug, info, notice, warning, error, critical, alert, emergency	默认：debug
handler	string	默认：修改此handler自定义自己的方法	zdz\LaravelMiddlewareLog\handle\SingleHandler::class

其他操作

使用zdz\LaravelMiddlewareLog\tool\FormatLog增加日志的内容

提供的方法

write(string $point, string $op, $context = '', bool $jsonStrToArray = true): void

$point：字段
$op：写入方式 FormatLog::LOG_WRITE 覆盖写入， FormatLog::LOG_APPEND 追加写入
$context：内容，字符串或者数组
$jsonStrToArray：是否将json转换成数组，默认true，避免json嵌套的问题

writeMany(array $array): void

$array 数组，会和日志数据做array_merge操作

zdz / laravel-middleware-log

Maintainers

Details

README

Requirements

Installation

Usage

注册中间件(选择合适的)

监听sql语句

Log结构

Configuration（可选，自定义配置）

其他操作

提供的方法

write(string $point, string $op, $context = '', bool $jsonStrToArray = true): void

writeMany(array $array): void