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

• General

• Batching

• Envelope

Fields

Field	Type	Required	Description
description General	string		describe this step.
condition General	lua-expression (string)		Only run this action if the condition is met. Examples: 2 * count()
size Batching	number (integer)		Maximum number of events before the batch flushes (optional). Examples: 42, 1.2e-10
timeout	time-interval (string)		Flush interval when the batch is not yet full. Examples: 500ms, 2h
end-of-document Batching	boolean (bool)		Flush outstanding events when a document-end marker arrives.
wrap-as-json Batching	boolean (bool)		Produce a JSON string representation of the batch alongside the records array.
header Envelope	string		Optional header emitted with each batch.
footer Envelope	string		Optional footer emitted with each batch.

General

Show fields

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()

Batching

Show fields

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.
wrap-as-json	boolean (bool)		Produce a JSON string representation of the batch alongside the records array.

Envelope

Show fields

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