apisix/doc/zh-cn/plugins/http-logger.md
2020-06-19 12:03:55 +08:00

3.0 KiB
Raw Blame History

Summary

定义

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

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

属性列表

属性名称 必选项 描述
uri 必要的 服务器的URI
authorization 可选的 授权头部
keepalive 可选的 发送请求后保持连接活动的时间
name 可选的 标识logger的唯一标识符
batch_max_size 可选的 每批的最大大小默认为1000
inactive_timeout 可选的 刷新缓冲区的最大时间以秒为单位默认值为5s
buffer_duration 可选的 必须先处理批次中最旧条目的最长期限以秒为单位默认值为5
max_retry_count 可选的 从处理管道中移除之前的最大重试次数默认为0
retry_delay 可选的 如果执行失败则应延迟执行流程的秒数默认为1

如何开启

  1. 这是有关如何为特定路由启用http-logger插件的示例。
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
      "plugins": {
            "http-logger": {
                 "uri": "127.0.0.1:80/postendpoint?param=1"
            }
       },
      "upstream": {
           "type": "roundrobin",
           "nodes": {
               "127.0.0.1:1980": 1
           }
      },
      "uri": "/hello"
}'

测试插件

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

禁用插件

在插件配置中删除相应的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
        }
    }
}'