PHPackages                             wpjscc/laralog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. wpjscc/laralog

ActiveLibrary[Logging & Monitoring](/categories/logging)

wpjscc/laralog
==============

Custom logger for capturing laravel http lifecycle info

v2.0.13(3y ago)034MITPHP

Since Jan 18Pushed 3y agoCompare

[ Source](https://github.com/wpjscc/laralog)[ Packagist](https://packagist.org/packages/wpjscc/laralog)[ RSS](/packages/wpjscc-laralog/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (9)Used By (0)

Laralog
=======

[](#laralog)

功能
--

[](#功能)

- 提供 Laravel Http 中间件，捕捉 Http 请求生命周期内的必要信息
- Http 生命周期信息以 `JSON` 格式记录到日志文件中
- 提供了日志 `JSON` 化格式组件，可以无缝使用 `Filebeat` 采集日志到 `ES` 中，避免做格式优化
- 提供了过滤请求中敏感信息的配置，可以过滤到请求参数中的敏感信息，例如，密码等

安装
--

[](#安装)

1. 方式一

    - 添加 `shallowman/laralog` 包声明到工程项目的 `composer.json` 文件中
    - 使用 `composer install` 命令安装
2. 方式二

    - 使用如下命令直接安装依赖 ```
        $ composer require shallowman/laralog
        ```
3. 配置文件发布

    - 在项目目录下面运行如下命令，发布 `config` 资源文件 ```
        php artisan vendor:publish --provider="Shallowman\Laralog\ServiceProvider"
        ```

配置
--

[](#配置)

### 配置 `Laravel` `Http` 中间件

[](#配置-laravel-http-中间件)

- 在 `app\Http\Kernel.php` 文件中，找到 `protected $middleware` 属性，添加如下声明。 ```
    $middleware = [
        ...
        \Shallowman\Laralog\Http\Middleware\CaptureRequestLifecycle::class,
    ];
    ```

### 配置写日志组件

[](#配置写日志组件)

- 在 `.env` 配置中设置默认 `LOG_CHANNEL`

    ```
    LOG_CHANNEL=daily
    DAILY_LARALOG_STORAGE_PATH=/path/to/log/laralog-app-%s.log
    ```
- 在 `config/logging.php` 中，设置默认日志频道 `channel` 为 `daily` 的日志组件，添加如下配置声明

    ```
    'daily' => [
         // Monolog 提供的 driver,保留不变
        'driver' => 'daily',
        // channel 名称，要与数组键名保持一致
        'name'   => 'daily',
        // 日志存储路径，及日志文件命名
        // 增加 Hostname 作为日志存储文件名后缀
        'path'   => sprintf(env('DAILY_LARALOG_STORAGE_PATH', storage_path('logs/laralog-%s.log')), gethostname()),
        // 指定使用的日志格式化组件类
        'tap'    => [
            \Shallowman\Laralog\Formatter\LaralogFormatter::class,
            \Shallowman\Laralog\Processor\LaralogProcessor::class,
        ],
        'level'  => 'info',
        // 日志文件保留天数
        'days'   => 7,
        // 在写日志文件前获得锁，避免并发写入造成的争抢，写错行
        'locking'=> true,
    ],
    ```
- 配置过滤敏感信息的键值，如需新增过滤的敏感信息，在 `config/laralog.php` 中 `fields` 键对应的数组中增加待过滤的请求参数键值（匹配方式使用精准匹配）。

    ```
    return [
        'except' => [
            'fields'=>[
                'password',
                'password_information',
                'password_confirm',
                'something_to_except',
            ],
        ],
    ];
    ```
- 配置过滤不捕捉特定 uri 的返回值，在 `config/laralog.php` 中 `uri` 键对应的数组中增加待过滤的 `uri`（匹配方式使用模糊匹配）。

    ```
       return [
           'except' => [
               'uri'=>[
                   '/welcome',
                   '/uri/to/filter'
               ],
           ],
       ];
    ```
- 配置 HTTP 请求 `request` 和 `response` 包体内容超过设置长度的折叠功能（按照 Multibyte 计算），在 `config/laralog.php` 中添加如下键值对（默认不折叠任何长度的日志）。

    ```
      'log_clipped_length' => env('LARALOG_CLIPPED_LENGTH', CaptureRequestLifecycle::POSITIVE_INFINITY),
    ```
- 配置日志存储路径，在 `.env` 文件中新增配置 `DAILY_LARALOG_STRORAGE_PATH=/path/to/laralog`
- 一个完整的 `config/laralog.php` 配置示例如下。

    ```