syslog | 支流科技文档

参数

请参阅插件通用配置了解所有插件可用的配置选项。

host
string
required
syslog 服务器的 IP 地址或主机名。
port
integer
required
syslog 服务器的目标端口。
timeout
integer
default: 3000
vaild vaule:
大于 0
上游发送数据的超时时间（毫秒）。
tls
boolean
default: false
如果为 true，则验证 TLS。
flush_limit
integer
default: 4096
vaild vaule:
大于 0
在将日志推送到 syslog 服务器之前，缓冲区和当前消息允许的最大大小（KB）。
drop_limit
integer
default: 1048576
vaild vaule:
大于 0
在丢弃日志之前，缓冲区和当前消息允许的最大大小（KB）。
sock_type
string
default: tcp
vaild vaule:
tcp or udp
使用的传输层协议。
pool_size
integer
default: 5
vaild vaule:
大于或等于 5
sock:keepalive 使用的保活连接池大小。
log_format
object
使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。
从 APISIX 3.15.0 开始，支持最多 5 层深度的嵌套日志格式结构。在 API7 企业版中，仅支持扁平键值结构；暂不支持嵌套结构。
你还可以使用插件元数据全局配置日志格式，这将为所有 syslog 插件实例配置日志格式。如果单个插件实例上配置的日志格式与插件元数据上配置的日志格式不同，则以单个插件实例上配置的日志格式为准。有关更多详细信息，请参阅示例。
include_req_body
boolean
default: false
如果为 true，则在日志中包含请求体。注意，如果请求体太大无法保存在内存中，由于 NGINX 的限制，它可能无法被记录。
include_req_body_expr
array[array]
一个或多个 APISIX 表达式条件的数组。仅当 include_req_body 为 true 时使用。只有当此处配置的表达式计算结果为 true 时，才会记录请求体。
include_resp_body
boolean
default: false
如果为 true，则在日志中包含响应体。
include_resp_body_expr
array[array]
一个或多个 APISIX 表达式条件的数组。仅当 include_resp_body 为 true 时使用。只有当此处配置的表达式计算结果为 true 时，才会记录响应体。
name
string
default: sys logger
批处理器的插件唯一标识符。如果你使用 Prometheus 监控 APISIX 指标，该名称将导出到 apisix_batch_process_entries 中。
batch_max_size
integer
default: 1000
vaild vaule:
大于 0
每个批次允许的最大日志条目数。一旦达到该数量，批次将被发送到日志服务。将此参数设置为 1 表示立即处理。
inactive_timeout
integer
default: 5
vaild vaule:
大于 0
在将批次发送到日志服务之前，等待新日志的最长时间（秒）。该值应小于 buffer_duration。
buffer_duration
integer
default: 60
vaild vaule:
大于 0
在将批次发送到日志服务之前，允许的最早条目的最大存在时间（秒）。
retry_delay
integer
default: 1
vaild vaule:
大于或等于 0
如果批次发送失败，重试发送到日志服务的时间间隔（秒）。
max_retry_count
integer
default: 60
vaild vaule:
大于或等于 0
允许的最大重试次数，超过此次数将丢弃日志条目。

插件元数据

log_format
object
使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。
从 APISIX 3.15.0 开始，支持最多 5 层深度的嵌套日志格式结构。在 API7 企业版中，仅支持扁平键值结构；暂不支持嵌套结构。

参数​

插件元数据​

参数

插件元数据