rocketmq-logger

描述

rocketmq-logger 插件可以将日志以 JSON 的形式推送给外部 RocketMQ 集群。

属性

名称类型必选项默认值有效值描述
nameserver_listobjectRocketMQ 的 nameserver 列表。
topicstring要推送的 topic 名称。
keystring发送消息的 keys。
tagstring发送消息的 tags。
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量NGINX 内置变量
timeoutinteger3[1,…]发送数据的超时时间。
use_tlsbooleanfalse当设置为 true 时,开启 TLS 加密。
access_keystring“”ACL 认证的 Access key,空字符串表示不开启 ACL。
secret_keystring“”ACL 认证的 Secret key。
namestring“rocketmq logger”标识 logger 的唯一标识符。如果您使用 Prometheus 监视 APISIX 指标,名称将以 apisix_batch_process_entries 导出。
meta_formatenum“default”[“default”,”origin”]default:获取请求信息以默认的 JSON 编码方式。origin:获取请求信息以 HTTP 原始请求方式。更多信息,请参考 meta_format
include_req_bodybooleanfalse[false, true]当设置为 true 时,包含请求体。注意:如果请求体无法完全存放在内存中,由于 NGINX 的限制,APISIX 无法将它记录下来。
include_req_body_exprarrayinclude_req_body 属性设置为 true 时进行过滤请求体,并且只有当此处设置的表达式计算结果为 true 时,才会记录请求体。更多信息,请参考 lua-resty-expr
include_resp_bodybooleanfalse[false, true]当设置为 true 时,包含响应体。
include_resp_body_exprarrayinclude_resp_body 属性设置为 true 时进行过滤响应体,并且只有当此处设置的表达式计算结果为 true 时,才会记录响应体。更多信息,请参考 lua-resty-expr

注意:schema 中还定义了 encrypt_fields = {"secret_key"},这意味着该字段将会被加密存储在 etcd 中。具体参考 加密存储字段

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

rocketmq-logger - 图1提示

数据首先写入缓冲区。当缓冲区超过 batch_max_sizebuffer_duration 设置的值时,则会将数据发送到 RocketMQ 服务器并刷新缓冲区。

如果发送成功,则返回 true。如果出现错误,则返回 nil,并带有描述错误的字符串 buffer overflow

meta_format 示例

  • default:
  1. {
  2. "upstream": "127.0.0.1:1980",
  3. "start_time": 1619414294760,
  4. "client_ip": "127.0.0.1",
  5. "service_id": "",
  6. "route_id": "1",
  7. "request": {
  8. "querystring": {
  9. "ab": "cd"
  10. },
  11. "size": 90,
  12. "uri": "/hello?ab=cd",
  13. "url": "http://localhost:1984/hello?ab=cd",
  14. "headers": {
  15. "host": "localhost",
  16. "content-length": "6",
  17. "connection": "close"
  18. },
  19. "method": "GET"
  20. },
  21. "response": {
  22. "headers": {
  23. "connection": "close",
  24. "content-type": "text/plain; charset=utf-8",
  25. "date": "Mon, 26 Apr 2021 05:18:14 GMT",
  26. "server": "APISIX/2.5",
  27. "transfer-encoding": "chunked"
  28. },
  29. "size": 190,
  30. "status": 200
  31. },
  32. "server": {
  33. "hostname": "localhost",
  34. "version": "2.5"
  35. },
  36. "latency": 0
  37. }
  • origin:
  1. GET /hello?ab=cd HTTP/1.1
  2. host: localhost
  3. content-length: 6
  4. connection: close
  5. abcdef

插件元数据设置

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

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

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

rocketmq-logger - 图3note

您可以这样从 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/rocketmq-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"}

启用插件

你可以通过如下命令在指定路由上启用 rocketmq-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. "rocketmq-logger": {
  6. "nameserver_list" : [ "127.0.0.1:9876" ],
  7. "topic" : "test2",
  8. "batch_max_size": 1,
  9. "name": "rocketmq logger"
  10. }
  11. },
  12. "upstream": {
  13. "nodes": {
  14. "127.0.0.1:1980": 1
  15. },
  16. "type": "roundrobin"
  17. },
  18. "uri": "/hello"
  19. }'

该插件还支持一次推送到多个 nameserver,示例如下:

  1. [
  2. "127.0.0.1:9876",
  3. "127.0.0.2:9876"
  4. ]

测试插件

你可以通过以下命令向 APISIX 发出请求:

  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. }'