Skip to main content
Version: 2.4

批处理机

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

构型#

创建批处理程序的唯一必需参数是函数。当批处理达到最大大小或缓冲区持续时间超过时,将执行该功能。

名称需求描述
id可选的标识批处理者的唯一标识符
batch_max_size可选的每批的最大大小,默认为1000
inactive_timeout可选的如果不活动,将刷新缓冲区的最大时间(以秒为单位),默认值为5s
buffer_duration可选的必须先处理批次中最旧条目的最大期限(以秒为单位),默认是5
max_retry_count可选的从处理管道中移除之前的最大重试次数;默认为零
retry_delay可选的如果执行失败,应该延迟进程执行的秒数;默认为1

以下代码显示了如何使用批处理程序的示例。批处理处理器将要执行的功能作为第一个参数,将批处理配置作为第二个参数。

local bp = require("apisix.plugins.batch-processor")local func_to_execute = function(entries)            -- serialize to json array core.json.encode(entries)            -- process/send data            return true       end
local config = {    max_retry_count  = 2,    buffer_duration  = 60,    inactive_timeout  = 5,    batch_max_size = 1,    retry_delay  = 0}

local batch_processor, err = bp:new(func_to_execute, config)
if batch_processor then    batch_processor:push({hello='world'})end

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