skywalking-logger

目录

• 定义
• 属性列表
• 如何开启
• 测试插件
• 插件元数据设置
• 禁用插件

定义

http-logger 是一个插件，可将 Access Log 数据通过 HTTP 推送到 SkyWalking OAP 服务器。如果上下文中存在 tracing context，插件会自动建立 trace 与日志的关联，并依赖于 SkyWalking Cross Process Propagation Headers Protocol 。

这将提供将 Access Log 数据作为JSON对象发送到 SkyWalking OAP 服务器的功能。

属性列表

名称	类型	必选项	默认值	有效值	描述
uri	string	必须			SkyWalking OAp 服务器的 URI。
timeout	integer	可选	3	[1,...]	发送请求后保持连接活动的时间。
name	string	可选	"skywalking logger"		标识 logger 的唯一标识符。
batch_max_size	integer	可选	1000	[1,...]	设置每批发送日志的最大条数，当日志条数达到设置的最大值时，会自动推送全部日志到 HTTP/HTTPS 服务。
inactive_timeout	integer	可选	5	[1,...]	刷新缓冲区的最大时间（以秒为单位），当达到最大的刷新时间时，无论缓冲区中的日志数量是否达到设置的最大条数，也会自动将全部日志推送到 HTTP/HTTPS 服务。
buffer_duration	integer	可选	60	[1,...]	必须先处理批次中最旧条目的最长期限（以秒为单位）。
max_retry_count	integer	可选	0	[0,...]	从处理管道中移除之前的最大重试次数。
retry_delay	integer	可选	1	[0,...]	如果执行失败，则应延迟执行流程的秒数。
include_req_body	boolean	可选	false	[false, true]	是否包括请求 body。false： 表示不包含请求的 body ； true： 表示包含请求的 body 。

如何开启

这是有关如何为特定路由启用 skywalking-logger 插件的示例。在此之前，需要有可用的 SkyWalking OAP 可以被访问。

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
      "plugins": {
            "skywalking-logger": {
                "uri": "http://127.0.0.1:12800"
            }
       },
      "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

完成上述步骤后，在可以 SkyWalking UI 查看到相关日志。

插件元数据设置

skywalking-logger 也是制定日志格式，与 http-logger 插件类似。

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

特别的，该设置是全局生效的，意味着指定 log_format 后，将对所有绑定 skywalking-logger 的 Route 或 Service 生效。

禁用插件

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

$ curl http://127.0.0.1:9080/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:1980": 1
        }
    }
}'