Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jiannei/laravel-logger

📝 Laravel 日志的扩展，更规范，更快速，更有效。
https://github.com/jiannei/laravel-logger

job-queue laravel-log-viewer laravel-logger mongodb-driver requestlogging sqllog

Last synced: 5 days ago
JSON representation

📝 Laravel 日志的扩展，更规范，更快速，更有效。

Host: GitHub
URL: https://github.com/jiannei/laravel-logger
Owner: jiannei
Created: 2020-11-30T07:33:21.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-01-11T06:20:27.000Z (10 months ago)
Last Synced: 2024-10-13T16:07:50.870Z (about 1 month ago)
Topics: job-queue, laravel-log-viewer, laravel-logger, mongodb-driver, requestlogging, sqllog
Language: PHP
Homepage:
Size: 42 KB
Stars: 25
Watchers: 1
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
 laravel-logger 


![Test](https://github.com/Jiannei/laravel-logger/workflows/Test/badge.svg)

[![StyleCI](https://github.styleci.io/repos/317144680/shield?branch=main)](https://github.styleci.io/repos/317144680?branch=main)

[![Latest Stable Version](http://poser.pugx.org/jiannei/laravel-logger/v)](https://packagist.org/packages/jiannei/laravel-logger)

[![Total Downloads](http://poser.pugx.org/jiannei/laravel-logger/downloads)](https://packagist.org/packages/jiannei/laravel-logger)

[![Monthly Downloads](http://poser.pugx.org/jiannei/laravel-logger/d/monthly)](https://packagist.org/packages/jiannei/laravel-logger)

[![Latest Unstable Version](http://poser.pugx.org/jiannei/laravel-logger/v/unstable)](https://packagist.org/packages/jiannei/laravel-logger)

[![License](http://poser.pugx.org/jiannei/laravel-logger/license)](https://packagist.org/packages/jiannei/laravel-logger)

## 社区讨论文章

- [是时候使用 Lumen 8 + API Resource 开发项目了！](https://learnku.com/articles/45311)

- [教你更优雅地写 API 之「路由设计」](https://learnku.com/articles/45526)

- [教你更优雅地写 API 之「规范响应数据」](https://learnku.com/articles/52784)

- [教你更优雅地写 API 之「枚举使用」](https://learnku.com/articles/53015)

- [教你更优雅地写 API 之「记录日志」](https://learnku.com/articles/53669)

- [教你更优雅地写 API 之「灵活地任务调度」](https://learnku.com/articles/58403)

## 介绍

`laravel-logger` 主要用来扩展项目中的日志记录，使调试更加方便。

## 概览

- 提供 `logger_async` 辅助函数，通过异步 Job 方式来记录日志；

- 增加 RequestLog 中间件来记录 api 的请求和响应；对于单个请求关联 `UNIQUE_ID`，根据`UNIQUE_ID`可以跟踪请求执行过程

- 适配 MongoDB 驱动，支持记录日志到 MongoDB；collection 支持按天、按月和按年拆分；(依赖 `mongodb/mongodb`或`jenssegers/mongodb`)

- 提供 `LOG_QUERY`、`LOG_REQUEST` 配置参数来开启关闭 sql 日志和 request 日志

## 安装

```shell

$ composer require jiannei/laravel-logger -vvv

```

## 配置

复制配置项到 `config/logging.php`中，参考：https://github.com/Jiannei/lumen-api-starter/blob/master/config/logging.php

### Laravel

- 添加中间件 RequestLog 来记录 API 请求日志

在 `app/Http/Kernel.php` 的 $middlewareGroups 中添加

```php

protected $middlewareGroups = [

    'api' => [

        \Jiannei\Logger\Laravel\Http\Middleware\RequestLog::class,// 加在这个地方

    ],

];

```

-

### Lumen

- 加载配置

```php

// bootstrap/app.php

$app->configure('logging');

```

- 添加中间件

```php

$app->middleware([

    \Jiannei\Logger\Laravel\Http\Middleware\RequestLog::class,

]);

```

- 注册服务容器

```php

$app->register(\Jiannei\Logger\Laravel\Providers\ServiceProvider::class);

```

### .env 中配置启用

```php

LOG_CHANNEL=mongo

LOG_SLACK_WEBHOOK_URL=

LOG_QUERY=true

LOG_REQUEST=true

# 如果使用的是 mongo channel 需要配置

LOG_MONGODB_SEPARATE=daily

LOG_MONGODB_LEVEL=debug

LOG_MONGODB_HOST=127.0.0.1

LOG_MONGODB_PORT=27017

LOG_MONGODB_DATABASE=logs

LOG_MONGODB_USERNAME=

LOG_MONGODB_PASSWORD=

LOG_MONGODB_AUTHENTICATION_DATABASE=admin

```

### 其他

如果需要记录日志到 MongoDB，需要先安装并配置[laravel-mongodb](https://github.com/jenssegers/laravel-mongodb)

## 如何使用

可以参考 [lumen-api-starter](https://github.com/Jiannei/lumen-api-starter) 中的实际使用示例。

### 使用

- `app/Repositories/Enums/LogEnum.php` 中定义记录日志时的 message

- 通过 logger_async 方法记录日志

```php

logger_async(LogEnum::SYSTEM_SQL, $arrayData);

```

- 如果队列任务异步执行，则需要开启队列消费 `php artisan queue:work`

- 记录到文件中的日志内容

```

[2021-01-18 12:03:36] local.DEBUG: System sql {"database":"lumen-api","duration":"11.08ms","sql":"select `roles`.*, `model_has_roles`.`model_id` as `pivot_model_id`, `model_has_roles`.`role_id` as `pivot_role_id`, `model_has_roles`.`model_type` as `pivot_model_type` from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `model_has_roles`.`model_id` = '11' and `model_has_roles`.`model_type` = 'App\\\\Repositories\\\\Models\\\\User'"} {"url":"/users","ip":"172.22.0.1","http_method":"get","server":"lumen-api.test","referrer":null,"unique_id":"43f54ea9-4ad4-47cf-b9da-1d3aa150ff61"}

[2021-01-18 12:03:36] local.DEBUG: System request {"request":[],"response":{"status":"success","code":200,"message":"操作成功","data":{"data":[{"id":1,"nickname":"Evert Stracke DVM","email":"[email protected]"},{"id":2,"nickname":"Milton Toy","email":"[email protected]"},{"id":3,"nickname":"Mrs. Alyce O'Hara","email":"[email protected]"},{"id":4,"nickname":"Prof. Evalyn Windler I","email":"[email protected]"},{"id":5,"nickname":"Brant Skiles","email":"[email protected]"},{"id":6,"nickname":"Sage Rodriguez I","email":"[email protected]"},{"id":7,"nickname":"Ms. Angelica Wiegand DVM","email":"[email protected]"},{"id":8,"nickname":"Newton Zieme","email":"[email protected]"},{"id":9,"nickname":"Natalia Ruecker","email":"[email protected]"},{"id":10,"nickname":"Hallie Parisian","email":"[email protected]"},{"id":11,"nickname":"Jiannei","email":"[email protected]"}],"meta":{"pagination":{"total":11,"count":11,"per_page":15,"current_page":1,"total_pages":1,"links":[]}}},"error":[]},"start":1610942614.450748,"end":1610942615.785696,"duration":"1.33s"} {"url":"/users","ip":"172.22.0.1","http_method":"GET","server":"lumen-api.test","referrer":null,"unique_id":"43f54ea9-4ad4-47cf-b9da-1d3aa150ff61"}

```

- 记录到 Mongodb 的日志内容

```

/* 1 */

{

    "_id" : ObjectId("60050999ee7d025d4c62c8c2"),

    "message" : "System sql",

    "context" : {

        "database" : "lumen-api",

        "duration" : "54.19ms",

        "sql" : "select count(*) as aggregate from `users`"

    },

    "level" : 100,

    "level_name" : "DEBUG",

    "channel" : "mongo",

    "datetime" : ISODate("2021-01-18T12:07:53.410+08:00"),

    "extra" : {

        "url" : "/users",

        "ip" : "172.22.0.1",

        "http_method" : "get",

        "server" : "lumen-api.test",

        "referrer" : null,

        "unique_id" : "0cda1927-bf14-4acf-88e8-1d9ed67170b5"

    }

}

/* 2 */

{

    "_id" : ObjectId("60050999ee7d025d4c62c8c3"),

    "message" : "System sql",

    "context" : {

        "database" : "lumen-api",

        "duration" : "2.42ms",

        "sql" : "select * from `users` limit 15 offset 0"

    },

    "level" : 100,

    "level_name" : "DEBUG",

    "channel" : "mongo",

    "datetime" : ISODate("2021-01-18T12:07:53.500+08:00"),

    "extra" : {

        "url" : "/users",

        "ip" : "172.22.0.1",

        "http_method" : "get",

        "server" : "lumen-api.test",

        "referrer" : null,

        "unique_id" : "0cda1927-bf14-4acf-88e8-1d9ed67170b5"

    }

}

```

## 特别说明

- SQL 日志记录参考：[laravel-query-logger](https://github.com/overtrue/laravel-query-logger)

## License

MIT