http-logger

描述

http-logger 插件可以将 APISIX 的日志数据推送到 HTTP 或 HTTPS 服务器。该插件提供了将日志数据请求作为 JSON 对象发送到监控工具或者其他 HTTP 服务器的功能。

属性

名称类型必选项默认值有效值描述
uristringHTTP 或 HTTPS 服务器的 URI。
auth_headerstring授权 header(如果需要)。
timeoutinteger3[1,…]发送请求后保持连接处于活动状态的时间。
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量NGINX 内置变量
include_req_bodybooleanfalse[false, true]当设置为 true 时,将请求体包含在日志中。如果请求体太大而无法保存在内存中,由于 NGINX 的限制,无法记录。
include_req_body_exprarrayinclude_req_body 属性设置为 true 时的过滤器。只有当此处设置的表达式求值为 true 时,才会记录请求体。有关更多信息,请参阅 lua-resty-expr
include_resp_bodybooleanfalse[false, true]当设置为 true 时,包含响应体。
include_resp_body_exprarrayinclude_resp_body 属性设置为 true 时,使用该属性并基于 lua-resty-expr 进行过滤。如果存在,则仅在表达式计算结果为 true 时记录响应。
concat_methodstring“json”[“json”, “new_line”]枚举类型: json:对所有待发日志使用 json.encode 编码。new_line:对每一条待发日志单独使用 json.encode 编码并使用 \n 连接起来。
ssl_verifybooleanfalse[false, true]当设置为 true 时验证证书。

该插件支持使用批处理器来聚合并批量处理条目(日志和数据)。这样可以避免该插件频繁地提交数据。默认情况下每 5 秒钟或队列中的数据达到 1000 条时,批处理器会自动提交数据,如需了解更多信息或自定义配置,请参考 Batch Processor

默认日志格式示例

  1. {
  2. "service_id": "",
  3. "apisix_latency": 100.99999809265,
  4. "start_time": 1703907485819,
  5. "latency": 101.99999809265,
  6. "upstream_latency": 1,
  7. "client_ip": "127.0.0.1",
  8. "route_id": "1",
  9. "server": {
  10. "version": "3.7.0",
  11. "hostname": "localhost"
  12. },
  13. "request": {
  14. "headers": {
  15. "host": "127.0.0.1:1984",
  16. "content-type": "application/x-www-form-urlencoded",
  17. "user-agent": "lua-resty-http/0.16.1 (Lua) ngx_lua/10025",
  18. "content-length": "12"
  19. },
  20. "method": "POST",
  21. "size": 194,
  22. "url": "http://127.0.0.1:1984/hello?log_body=no",
  23. "uri": "/hello?log_body=no",
  24. "querystring": {
  25. "log_body": "no"
  26. }
  27. },
  28. "response": {
  29. "headers": {
  30. "content-type": "text/plain",
  31. "connection": "close",
  32. "content-length": "12",
  33. "server": "APISIX/3.7.0"
  34. },
  35. "status": 200,
  36. "size": 123
  37. },
  38. "upstream": "127.0.0.1:1982"
  39. }

插件元数据

名称类型必选项默认值有效值描述
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头。则表明获取 APISIX 变量NGINX 内置变量
http-logger - 图1注意

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

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

http-logger - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/http-logger \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "log_format": {
  5. "host": "$host",
  6. "@timestamp": "$time_iso8601",
  7. "client_ip": "$remote_addr"
  8. }
  9. }'

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

  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"}

启用插件

你可以通过如下命令在指定路由上启用 http-logger 插件:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "plugins": {
  5. "http-logger": {
  6. "uri": "http://mockbin.org/bin/:ID"
  7. }
  8. },
  9. "upstream": {
  10. "type": "roundrobin",
  11. "nodes": {
  12. "127.0.0.1:1980": 1
  13. }
  14. },
  15. "uri": "/hello"
  16. }'

mockbin 服务器用于模拟 HTTP 服务器,以方便查看 APISIX 生成的日志。

测试插件

你可以通过以下命令向 APISIX 发出请求,访问日志将记录在你的 mockbin 服务器中:

  1. curl -i http://127.0.0.1:9080/hello

删除插件

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

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