Skip to main content
Version: Next

file-logger

描述#

file-logger 插件可用于将日志数据存储到指定位置。

提示

file-logger 插件特点如下:

  • 可将指定路由的日志发送到指定位置,方便你在本地统计各个路由的请求和响应数据。在使用 debug mode 时,你可以很轻松地将出现问题的路由的日志输出到指定文件中,从而更方便地排查问题。
  • 可以获取 APISIX 变量NGINX 变量,而 access.log 仅能使用 NGINX 变量。
  • 支持热加载,你可以在路由中随时更改其配置并立即生效。而修改 access.log 相关配置,则需要重新加载 APISIX。
  • 支持以 JSON 格式保存日志数据。
  • 可以在 log phase 阶段修改 file-logger 执行的函数来收集你所需要的信息。

属性#

名称类型必选项描述
pathstring自定义输出文件路径。例如:logs/file.log

插件元数据设置#

名称类型必选项默认值有效值描述
log_formatobject可选{"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"}以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量NGINX 内置变量
注意

该设置全局生效。如果指定了 log_format,则所有绑定 file-logger 的路由或服务都将使用该日志格式。

以下示例展示了如何通过 Admin API 配置插件元数据:

curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/file-logger \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"log_format": {
"host": "$host",
"@timestamp": "$time_iso8601",
"client_ip": "$remote_addr"
}
}'

配置完成后,你可以在日志系统中看到如下类似日志:

{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}

启用插件#

你可以通过以下命令在指定路由中启用该插件:

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"plugins": {
"file-logger": {
"path": "logs/file.log"
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:9001": 1
}
},
"uri": "/hello"
}'

测试插件#

你可以通过以下命令向 APISIX 发出请求:

curl -i http://127.0.0.1:9080/hello
HTTP/1.1 200 OK
...
hello, world

访问成功后,你可以在对应的 logs 目录下找到 file.log 文件。

禁用插件#

当你需要禁用该插件时,可以通过如下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

curl http://127.0.0.1:9180/apisix/admin/routes/1  \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/hello",
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:9001": 1
}
}
}'