Batch In

Batch In (batch-in)

Accumulate events into batches before downstream processing.

Transform json

Minimal example

actions:
  - batch-in: {}

JSON

{
  "actions": [
    {
      "batch-in": {}
    }
  ]
}

Contents

• Minimal example

• Fields

• Batching

• Envelope

• General

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Fields

Field	Type	Required	Description
timeout	time-interval (string)		Flush interval when the batch is not yet full. Default: 100ms Examples: 500ms, 2h

Batching

Batching

Field	Type	Required	Description
size ✓	number (integer)		Maximum number of events before the batch flushes (optional). Examples: 42, 1.2e-10
end-of-document ✓	boolean (bool)		Flush outstanding events when a document-end marker arrives. Default: false
wrap-as-json ✓	boolean (bool)		Produce a JSON string representation of the batch alongside the records array. Default: false

Envelope

Envelope

Field	Type	Required	Description
header	string		Optional header emitted with each batch.
footer	string		Optional footer emitted with each batch.

General

General

Field	Type	Required	Description
description	string		describe this step.
condition	lua-expression (string)		Only run this action if the condition is met. Examples: 2 * count()