Test StyleCI Latest Stable Version Total Downloads Monthly Downloads Latest Unstable Version License
- 是时候使用 Lumen 8 + API Resource 开发项目了!
- 教你更优雅地写 API 之「路由设计」
- 教你更优雅地写 API 之「规范响应数据」
- 教你更优雅地写 API 之「枚举使用」
- 教你更优雅地写 API 之「记录日志」
- 教你更优雅地写 API 之「灵活地任务调度」
laravel-logger 主要用来扩展项目中的日志记录,使调试更加方便。
- 提供
logger_async辅助函数,通过异步 Job 方式来记录日志; - 增加 RequestLog 中间件来记录 api 的请求和响应;对于单个请求关联
UNIQUE_ID,根据UNIQUE_ID可以跟踪请求执行过程 - 适配 MongoDB 驱动,支持记录日志到 MongoDB;collection 支持按天、按月和按年拆分;(依赖
mongodb/mongodb或jenssegers/mongodb) - 提供
LOG_QUERY、LOG_REQUEST配置参数来开启关闭 sql 日志和 request 日志
$ composer require jiannei/laravel-logger -vvv
复制配置项到 config/logging.php中,参考:https://github.com/Jiannei/lumen-api-starter/blob/master/config/logging.php
- 添加中间件 RequestLog 来记录 API 请求日志
在 app/Http/Kernel.php 的 $middlewareGroups 中添加
protected $middlewareGroups = [ 'api' => [ \Jiannei\Logger\Laravel\Http\Middleware\RequestLog::class,// 加在这个地方 ], ];
- 加载配置
// bootstrap/app.php $app->configure('logging');
- 添加中间件
$app->middleware([ \Jiannei\Logger\Laravel\Http\Middleware\RequestLog::class, ]);
- 注册服务容器
$app->register(\Jiannei\Logger\Laravel\Providers\ServiceProvider::class);
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
可以参考 lumen-api-starter 中的实际使用示例。
app/Repositories/Enums/LogEnum.php中定义记录日志时的 message- 通过 logger_async 方法记录日志
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":"aufderhar.kaden@example.net"},{"id":2,"nickname":"Milton Toy","email":"keagan.eichmann@example.org"},{"id":3,"nickname":"Mrs. Alyce O'Hara","email":"cartwright.sidney@example.org"},{"id":4,"nickname":"Prof. Evalyn Windler I","email":"bertram.bartoletti@example.org"},{"id":5,"nickname":"Brant Skiles","email":"jane16@example.net"},{"id":6,"nickname":"Sage Rodriguez I","email":"ryder50@example.org"},{"id":7,"nickname":"Ms. Angelica Wiegand DVM","email":"kaelyn.mueller@example.net"},{"id":8,"nickname":"Newton Zieme","email":"sipes.kip@example.com"},{"id":9,"nickname":"Natalia Ruecker","email":"stroman.kiley@example.com"},{"id":10,"nickname":"Hallie Parisian","email":"rosina74@example.net"},{"id":11,"nickname":"Jiannei","email":"longjian.huang@foxmail.com"}],"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
MIT