摘要

定义

sls-logger 是使用RF5424标准将日志数据以JSON格式发送到阿里云日志服务。

该插件提供了将Log Data作为批处理推送到阿里云日志服务器的功能。如果您没有收到日志数据，请放心一些时间，它会在我们的批处理处理器中的计时器功能到期后自动发送日志。

有关Apache APISIX中Batch-Processor的更多信息，请参考： Batch-Processor

属性列表

属性名称 必选项 描述
host 必要的 TCP 服务的IP地址或主机名，请参考：阿里云日志服务列表，建议配置 IP 取代配置域名。
port 必要的 目标端口，阿里云日志服务默认端口为 10009。
timeout 可选的 发送数据超时间。
project 必要的 日志服务Project名称，请提前在阿里云日志服务中创建 Project。
logstore 必须的 日志服务Logstore名称，请提前在阿里云日志服务中创建 Logstore。
access_key_id 必须的 AccessKey ID。建议使用阿里云子账号AK，详情请参见授权。
access_key_secret 必须的 AccessKey Secret。建议使用阿里云子账号AK，详情请参见授权。
include_req_body 可选的 是否包含请求体。
name 可选的 批处理名字。
batch_max_size 可选的 每批的最大大小。
inactive_timeout 可选的 如果不活动，将刷新缓冲区的最大时间（以秒为单位）。
buffer_duration 可选的 必须先处理批次中最旧条目的最大期限（以秒为单位）。
max_retry_count 可选的 从处理管道中移除之前的最大重试次数。
retry_delay 可选的 如果执行失败，应该延迟进程执行的秒数。

如何开启

  1. 下面例子展示了如何为指定路由开启 sls-logger 插件的。
  1. curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "plugins": {
  4.         "sls-logger": {
  5.             "host": "100.100.99.135",
  6.             "port": 10009,
  7.             "project": "your_project",
  8.             "logstore": "your_logstore",
  9.             "access_key_id": "your_access_key_id",
  10.             "access_key_secret": "your_access_key_secret",
  11.             "timeout": 30000
  12.         }
  13.     },
  14.     "upstream": {
  15.         "type": "roundrobin",
  16.         "nodes": {
  17.             "127.0.0.1:1980": 1
  18.         }
  19.     },
  20.     "uri": "/hello"
  21. }'
  1. 注释:这里的 100.100.99.135 是阿里云华北3内外地址。

测试插件

  • 成功的情况:
  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. hello, world
  • 查看阿里云日志服务上传记录 sls-logger - 图1

禁用插件

想要禁用“sls-logger”插件，是非常简单的，将对应的插件配置从json配置删除，就会立即生效，不需要重新启动服务：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value='
  2. {
  3.     "uri": "/hello",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }
  10.     }
  11. }'