Skip to main content
Version: 2.12

sls-logger

摘要#

定义#

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 插件的。
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"plugins": {
"sls-logger": {
"host": "100.100.99.135",
"port": 10009,
"project": "your_project",
"logstore": "your_logstore",
"access_key_id": "your_access_key_id",
"access_key_secret": "your_access_key_secret",
"timeout": 30000
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
},
"uri": "/hello"
}'
注释:这里的 100.100.99.135 是阿里云华北 3 内外地址。

测试插件#

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

禁用插件#

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

$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/hello",
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'