Skip to main content
Version: 2.14

批处理器

批处理器可用于聚合条目（日志/任何数据）并进行批处理。 当 batch_max_size 设置为零时，处理器将立即执行每个条目。将批处理的最大值设置为大于 1 将开始聚合条目，直到达到最大值或超时。

配置#

创建批处理器的唯一必需参数是函数。当批处理达到最大值或缓冲区持续时间超过时，函数将被执行。

名称类型必选项默认值有效值描述
namestring可选xxx logger["http logger", "Some strings",...]用于标识批处理器的唯一标识符，默认为调用批处理器的日志插件名字，如配置插件为 http logger，name 默认为 http logger。
batch_max_sizeinteger可选1000[1,...]设置每批发送日志的最大条数，当日志条数达到设置的最大值时，会自动推送全部日志到 HTTP/HTTPS 服务。
inactive_timeoutinteger可选5[1,...]刷新缓冲区的最大时间（以秒为单位），当达到最大的刷新时间时，无论缓冲区中的日志数量是否达到设置的最大条数，也会自动将全部日志推送到 HTTP/HTTPS 服务。
buffer_durationinteger可选60[1,...]必须先处理批次中最旧条目的最长期限（以秒为单位）。
max_retry_countinteger可选0[0,...]从处理管道中移除之前的最大重试次数。
retry_delayinteger可选1[0,...]如果执行失败，则应延迟执行流程的秒数。

以下代码显示了如何在你的插件中使用批处理器：

local bp_manager_mod = require("apisix.utils.batch-processor-manager")...
local plugin_name = "xxx-logger"local batch_processor_manager = bp_manager_mod.new(plugin_name)local schema = {...}local _M = {    ...    name = plugin_name,    schema = batch_processor_manager:wrap_schema(schema),}
...

function _M.log(conf, ctx)    local entry = {...} -- data to log
    if batch_processor_manager:add_entry(conf, entry) then        return    end    -- create a new processor if not found
    -- entries is an array table of entry, which can be processed in batch    local func = function(entries)        -- serialize to json array core.json.encode(entries)        -- process/send data        return true        -- return false, err_msg, first_fail if failed        -- first_fail(optional) indicates first_fail-1 entries have been successfully processed        -- and during processing of entries[first_fail], the error occurred. So the batch processor        -- only retries for the entries having index >= first_fail as per the retry policy.    end    batch_processor_manager:add_entry_to_new_processor(conf, entry, ctx, func)end

批处理器的配置将通过该插件的配置设置。 举个例子：

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{      "plugins": {            "http-logger": {                "uri": "http://mockbin.org/bin/:ID",                "batch_max_size": 10,                "max_retry_count": 1            }       },      "upstream": {           "type": "roundrobin",           "nodes": {               "127.0.0.1:1980": 1           }      },      "uri": "/hello"}'

如果你的插件只使用一个全局的批处理器， 你可以直接使用它：

local entry = {...} -- data to logif log_buffer then    log_buffer:push(entry)    returnend
local config_bat = {    name = config.name,    retry_delay = config.retry_delay,    ...}
local err-- entries is an array table of entry, which can be processed in batchlocal func = function(entries)    ...    return true    -- return false, err_msg, first_fail if failedendlog_buffer, err = batch_processor:new(func, config_bat)
if not log_buffer then    core.log.warn("error when creating the batch processor: ", err)    returnend
log_buffer:push(entry)

注意：请确保批处理的最大值（条目数）在函数执行的范围内。 刷新批处理的计时器基于 inactive_timeout 配置运行。因此，为了获得最佳使用效果， 保持 inactive_timeout 小于 buffer_duration。