skywalking-logger

描述

skywalking-logger 插件可用于将 APISIX 的访问日志数据推送到 SkyWalking OAP 服务器。

如果上下文中存在 tracing context，插件会自动建立 trace 与日志的关联，该功能依赖于 SkyWalking Cross Process Propagation Headers Protocol。

该插件也提供了将访问日志作为 JSON 对象发送到 SkyWalking OAP 服务器的能力。

属性

名称类型必选项默认值有效值描述
endpoint_addrstring是SkyWalking OAP 服务器的 URI。
service_namestring否“APISIX”SkyWalking 服务名称。
service_instance_namestring否“APISIX Instance Name”SkyWalking 服务的实例名称。当设置为 $hostname会直接获取本地主机名。
log_formatobject否以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头，则表明是要获取 APISIX 变量 或 NGINX 内置变量。
timeoutinteger否3[1,…]发送请求后保持连接活动的时间。
namestring否“skywalking logger”标识 logger 的唯一标识符。如果您使用 Prometheus 监视 APISIX 指标，名称将以 apisix_batch_process_entries 导出。
include_req_bodyboolean否false[false, true]当设置为 true 时，将请求正文包含在日志中。
include_req_body_exprarray否当 include_req_body 属性设置为 true 时的过滤器。只有当此处设置的表达式求值为 true 时，才会记录请求体。有关更多信息，请参阅 lua-resty-expr 。
include_resp_bodyboolean否false[false, true]当设置为 true 时，包含响应体。
include_resp_body_exprarray否当 include_resp_body 属性设置为 true 时进行过滤响应体，并且只有当此处设置的表达式计算结果为 true 时，才会记录响应体。更多信息，请参考 lua-resty-expr。

该插件支持使用批处理器来聚合并批量处理条目（日志/数据）。这样可以避免插件频繁地提交数据，默认设置情况下批处理器会每 5 秒钟或队列中的数据达到 1000 条时提交数据，如需了解批处理器相关参数设置，请参考 Batch-Processor。

默认日志格式示例

  1.  {
  2.     "serviceInstance": "APISIX Instance Name",
  3.     "body": {
  4.       "json": {
  5.         "json": "body-json"
  6.       }
  7.     },
  8.     "endpoint": "/opentracing",
  9.     "service": "APISIX"
  10.   }

对于 body-json 数据，它是一个转义后的 json 字符串，格式化后如下：

  1.   {
  2.     "response": {
  3.       "status": 200,
  4.       "headers": {
  5.         "server": "APISIX/3.7.0",
  6.         "content-type": "text/plain",
  7.         "transfer-encoding": "chunked",
  8.         "connection": "close"
  9.       },
  10.       "size": 136
  11.     },
  12.     "route_id": "1",
  13.     "upstream": "127.0.0.1:1982",
  14.     "upstream_latency": 8,
  15.     "apisix_latency": 101.00020599365,
  16.     "client_ip": "127.0.0.1",
  17.     "service_id": "",
  18.     "server": {
  19.       "hostname": "localhost",
  20.       "version": "3.7.0"
  21.     },
  22.     "start_time": 1704429712768,
  23.     "latency": 109.00020599365,
  24.     "request": {
  25.       "headers": {
  26.         "content-length": "9",
  27.         "host": "localhost",
  28.         "connection": "close"
  29.       },
  30.       "method": "POST",
  31.       "body": "body-data",
  32.       "size": 94,
  33.       "querystring": {},
  34.       "url": "http://localhost:1984/opentracing",
  35.       "uri": "/opentracing"
  36.     }
  37.   }

配置插件元数据

skywalking-logger 也支持自定义日志格式，与 http-logger 插件类似。

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

该配置全局生效。如果你指定了 log_format，该配置就会对所有绑定 skywalking-logger 的路由或服务生效。

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

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

启用插件

完成 SkyWalking OAP 配置后，你可以通过以下命令在路由中启用该插件：

  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.             "skywalking-logger": {
  6.                 "endpoint_addr": "http://127.0.0.1:12800"
  7.             }
  8.        },
  9.       "upstream": {
  10.            "type": "roundrobin",
  11.            "nodes": {
  12.                "127.0.0.1:1980": 1
  13.            }
  14.       },
  15.       "uri": "/hello"
  16. }'

测试插件

现在你可以向 APISIX 发起请求：

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

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

删除插件

当你需要删除该插件时，可通过以下命令删除相应的 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. }'