Skip to main content
Version: 2.8

http-logger

目录#

定义#

http-logger 是一个插件，可将Log数据请求推送到 HTTP / HTTPS 服务器。

这将提供将 Log 数据请求作为JSON对象发送到监视工具和其他 HTTP 服务器的功能。

属性列表#

名称类型必选项默认值有效值描述
uristring必须HTTP/HTTPS 服务器的 URI。
auth_headerstring可选""授权头部。
timeoutinteger可选3[1,...]发送请求后保持连接活动的时间。
namestring可选"http logger"标识 logger 的唯一标识符。
batch_max_sizeinteger可选1000[1,...]设置每批发送日志的最大条数，当日志条数达到设置的最大值时，会自动推送全部日志到 HTTP/HTTPS 服务。
inactive_timeoutinteger可选5[1,...]刷新缓冲区的最大时间（以秒为单位），当达到最大的刷新时间时，无论缓冲区中的日志数量是否达到设置的最大条数，也会自动将全部日志推送到 HTTP/HTTPS 服务。
buffer_durationinteger可选60[1,...]必须先处理批次中最旧条目的最长期限（以秒为单位）。
max_retry_countinteger可选0[0,...]从处理管道中移除之前的最大重试次数。
retry_delayinteger可选1[0,...]如果执行失败，则应延迟执行流程的秒数。
include_req_bodyboolean可选false[false, true]是否包括请求 body。false： 表示不包含请求的 body ； true： 表示包含请求的 body 。
concat_methodstring可选"json"["json", "new_line"]枚举类型： json、new_line。json: 对所有待发日志使用 json.encode 编码。new_line: 对每一条待发日志单独使用 json.encode 编码并使用 "\n" 连接起来。

如何开启#

这是有关如何为特定路由启用 http-logger 插件的示例。你可以在 mockbin 生成一个模拟 HTTP 服务器来浏览生成的日志

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{      "plugins": {            "http-logger": {                "uri": "http://mockbin.org/bin/:ID"            }       },      "upstream": {           "type": "roundrobin",           "nodes": {               "127.0.0.1:1980": 1           }      },      "uri": "/hello"}'

测试插件#

成功:

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

插件元数据设置#

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

APISIX 变量

变量名描述使用示例
route_idroute 的 id$route_id
route_nameroute 的 name$route_name
service_idservice 的 id$service_id
service_nameservice 的 name$service_name
consumer_nameconsumer 的 username$consumer_name

设置日志格式示例#

curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/http-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"}

禁用插件#

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

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