file-logger

描述

file-logger 是一个插件，可将 Log 数据流推送到指定位置，例如，可以自定义输出路径：logs/file.log。

属性列表

名称类型必选项默认值有效值描述
pathstring必须自定义输出文件路径

如何开启

这是有关如何为特定路由启用 file-logger 插件的示例。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.   "plugins": {
  4.     "file-logger": {
  5.       "path": "logs/file.log"
  6.     }
  7.   },
  8.   "upstream": {
  9.     "type": "roundrobin",
  10.     "nodes": {
  11.       "127.0.0.1:9001": 1
  12.     }
  13.   },
  14.   "uri": "/hello"
  15. }'

测试插件

成功:

  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. hello, world

然后你可以在对应的 logs 目录下找到 file.log 文件。

插件元数据设置

名称类型必选项默认值有效值描述
log_formatobject可选{“host”: “$host”, “@timestamp”: “$time_iso8601”, “client_ip”: “$remote_addr”}以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头，则表明是要获取 APISIX 变量 或 Nginx 内置变量。特别的，该设置是全局生效的，意味着指定 log_format 后，将对所有绑定 http-logger 的 Route 或 Service 生效。

设置日志格式示例

  1. curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/file-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "log_format": {
  4.         "host": "$host",
  5.         "@timestamp": "$time_iso8601",
  6.         "client_ip": "$remote_addr"
  7.     }
  8. }'

在日志收集处，将得到类似下面的日志：

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

禁用插件

在插件配置中删除相应的 json 配置以禁用 file-logger。APISIX 插件是热重载的，因此无需重新启动 APISIX：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/hello",
  5.     "plugins": {},
  6.     "upstream": {
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:9001": 1
  10.         }
  11.     }
  12. }'