参数
请参阅插件通用配置,了解所有插件通用的配置选项。
endpoint_addr
已废弃,请改用
endpoint_addrs。Elasticsearch API 端点地址。endpoint_addr和endpoint_addrs二选一配置。endpoint_addrs
Elasticsearch API 端点地址。如果配置了多个端点,每次写入会随机选择一个。
endpoint_addrs和已废弃的endpoint_addr二选一配置。log_format_extra
用于向默认日志条目添加额外字段,使用 JSON 格式的键值对。值可引用内置变量。已配置的字段不会覆盖现有默认字段。插件实例优先于插件元数据;在实例上设置空对象会禁用元数据值。配置
log_format时,log_format_extra会被忽略。自 API7 企业版 3.9.15、3.10.2 和 APISIX 3.18.0 起引入。auth
Elasticsearch 用户认证配置。
username
Elasticsearch 认证用户名。
password
Elasticsearch 认证密码。该值会在存储前加密。
headers
发送到 Elasticsearch 的自定义 HTTP 请求头,以键值对形式配置。可作为
auth的替代或补充,用于认证或其他用途。自 API7 企业版 3.9.16、3.10.2 和 APISIX 3.16.0 起引入。请求头值加密自 API7 企业版 3.9.16、3.10.2 和 APISIX 3.18.0 起引入。启用数据加密时,这些值会在存储前加密。经授权的 Admin APIGET请求会返回完整的已解密请求头对象;静态加密不会在 API 响应中隐藏请求头名称或值。ssl_verify
如果为 true,则执行 SSL 验证。
timeout
Elasticsearch 发送数据超时时间(秒)。
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
一个批次允许的日志条目数。达到该数量后,批次会发送到 Elasticsearch。将此参数设置为 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会被忽 略。自 API7 企业版 3.9.15、3.10.2 和 APISIX 3.18.0 起引入。max_pending_entries
有效值:
大于或等于 1
批处理器中等待处理的最大条目数。当积压达到此限制时,新条目会被丢弃。
此参数在 API7 企业版 3.8.17 和 APISIX 3.15.0 中引入。
在 APISIX 3.18.0、API7 企业版 3.9 分支的 3.9.19 以及 3.10 分支的 3.10.6 中,默认值变更为
8192。在 API7 企业版 3.9.18、3.10.5 及更早的 APISIX 版本中,省略该参数会使积压队列不设上限。有关容量规划和验证指南,请参见批处理器。