参数
请参阅插件通用配置,了解所有插件通用的配置选项。
host
syslog 服务器的 IP 地址或主机名。
port
syslog 服务器的目标端口。
timeout
有效值:
大于 0
上游发送数据的超时时间(毫秒)。
tls
如果为 true,则验证 TLS。
flush_limit
有效值:
大于 0
在将日志推送到 syslog 服务器之前,缓冲区和当前消息允许的最大大小(KB)。
drop_limit
有效值:
大于 0
在丢弃日志之前,缓冲区和当前消息允许的最大大小(KB)。
sock_type
有效值:
tcp或udp使用的传输层协议。
pool_size
有效值:
大于或等于 5
sock:keepalive使用的保活连接池大小。log_format_extra
在默认日志条目之上叠加的额外日志字段,使用 JSON 格式的键值对。取值可引用内置变量。与会替换整个默认日志条目的
log_format不同,log_format_extra会保留默认条目并在其上添加所配置的字段。当设置了log_format时,log_format_extra会被忽略。自 API7 企业版 3.9.15 版本起可用。include_req_body
如果为 true,则在日志中包含请求体。注意,如果请求体太大无法保存在内存中,由于 NGINX 的限制,它可能无法被记录。
include_req_body_expr
一个或多个 APISIX 表达式 条件的数组。仅当
include_req_body为 true 时使用。只有当此处配置的表达式计算结果为 true 时,才会记录请求体。include_resp_body
如果为 true,则在日志中包含响应体。
include_resp_body_expr
一个或多个 APISIX 表达式 条件的数组。仅当
include_resp_body为 true 时使用。只有当此处配置的表达式计算结果为 true 时,才会记录响应体。max_req_body_bytes
有效值:
大于或等于 1
日志中包含的请求体大小上限(字节)。如果请求体超过此值,将被截断。自 APISIX 3.16.0 起可用。
max_resp_body_bytes
有效值:
大于或等于 1
日志中包含的响应体大小上限(字节)。如果响应体超过此值,将被截断。自 APISIX 3.16.0 起可用。
name
批处理器的插件唯一标识符。如果你使用 Prometheus 监控 APISIX 指标,该名称将导出到
apisix_batch_process_entries中。batch_max_size
有效值:
大于 0
每个批次允许的最大日志条目数。一旦达到该数量,批次将被发送到日志服务。将此参数设置为 1 表示立即处理。
inactive_timeout
有效值:
大于 0
在将批次发送到日志服务之前,等待新日志的最长时间(秒)。该值应小于
buffer_duration。buffer_duration
有效值:
大于 0
在将批次发送到日志服务之前,允许的最早条目的最大存在时间(秒)。
retry_delay
有效值:
大于或等于 0
如果批次发送失败,重试发送到日志服务的时间间隔(秒)。
max_retry_count
有效值:
大于或等于 0
允许的最大重试次数,超过此次数将丢弃日志条目。
插件元数据
log_format
使用 JSON 格式的键值对自定义日志格式。值可以引用 内置变量。
从 APISIX 3.15.0 开始,支持最多 5 层深度的嵌套日志格式结构。在 API7 企业版中,仅支持扁平键值结构;暂不支持嵌套结构。
log_format_extra
在默认日志条目之上叠加的额外日志字段,使用 JSON 格式的键值对。取值可引用内置变量。与会替换整个默认日志条目的
log_format不同,log_format_extra会保留默认条目并在其上添加所配置的字段。当设置了log_format时,log_format_extra会被忽略。自 API7 企业版 3.9.15 版本起可用。