tencent-cloud-cls

描述

tencent-cloud-cls 插件可用于将 APISIX 日志使用腾讯云日志服务 API 推送到您的日志主题。

属性

名称类型必选项默认值有效值描述
cls_hoststringCLS API 域名,参考使用 API 上传日志
cls_topicstringCLS 日志主题 id。
secret_idstring云 API 密钥的 id。
secret_keystring云 API 密钥的 key。
sample_rationumber1[0.00001, 1]采样的比例。设置为 1 时,将对所有请求进行采样。
include_req_bodybooleanfalse[false, true]当设置为 true 时,日志中将包含请求体。
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
global_tagobjectkv 形式的 JSON 数据,可以写入每一条日志,便于在 CLS 中检索。
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量NGINX 内置变量

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

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

默认日志格式示例

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

插件元数据

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

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

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

  1. curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/tencent-cloud-cls \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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"}

启用插件

你可以通过以下命令在指定路由中启用该插件:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4. "plugins": {
  5. "tencent-cloud-cls": {
  6. "cls_host": "ap-guangzhou.cls.tencentyun.com",
  7. "cls_topic": "${your CLS topic name}",
  8. "global_tag": {
  9. "module": "cls-logger",
  10. "server_name": "YourApiGateWay"
  11. },
  12. "include_req_body": true,
  13. "include_resp_body": true,
  14. "secret_id": "${your secret id}",
  15. "secret_key": "${your secret key}"
  16. }
  17. },
  18. "upstream": {
  19. "type": "roundrobin",
  20. "nodes": {
  21. "127.0.0.1:1980": 1
  22. }
  23. },
  24. "uri": "/hello"
  25. }'

测试插件

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

  1. curl -i http://127.0.0.1:9080/hello
  1. HTTP/1.1 200 OK
  2. ...
  3. hello, world

删除插件

当你需要删除该插件时,可通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'