Skip to content

Transaction

Transaction (transaction)

Sessionize related events using start/end markers and optional summary fields.

Stateful Transform json

Minimal example

actions:
- transaction: {}
JSON
{
"actions": [
{
"transaction": {}
}
]
}

Contents

Behaviour

Behaviour
FieldTypeRequiredDescription
use-document-markerboolean (bool)Treat document boundaries as transaction markers.
Default: false

Detection

Detection
FieldTypeRequiredDescription
startstringField/pattern (e.g. “type:start”) that opens a transaction.
endstringField/pattern that closes a transaction.

General

General
FieldTypeRequiredDescription
descriptionstringDescribe this step.
conditionlua-expression (string)Only run this action when the Lua condition evaluates to true.
Examples: 2 * count()

Input

Input
FieldTypeRequiredDescription
group-byfield (string)Group sessions independently by this field.
Examples: data_field

Output

Output
FieldTypeRequiredDescription
markerstringMarker placed on emitted transaction envelopes.
common-fieldsstring[]Common fields copied from each record to the transaction envelope.
combined-outputboolean (bool)Emit a single combined event for the session instead of individual events.
Default: false
combined-payloadboolean (bool)When true, attach the payload array under _payload.
Default: false

Summary

Summary
FieldTypeRequiredDescription
session-summaryTransaction Session SummaryOptional session summary output (counts, durations, numeric stats).

Timeouts

Timeouts
FieldTypeRequiredDescription
timeout-fieldstringMarker emitted when upstream stalled events close an open transaction.
idle-timeoutduration (string)Idle timeout that auto-closes sessions without explicit end markers (e.g. “5m”).

Schema

Transaction Session Summary - Transaction Session Numeric Field Fields

FieldTypeRequiredDescription
fieldfield (string)Field to analyse across the session.
Examples: data_field
opsTransaction Session Metric Operation[]Operations to compute for the numeric field.
Allowed values: min, max, sum, mean, stddev
prefixstringOptional prefix applied to emitted metric fields.

Transaction Session Summary Fields

FieldTypeRequiredDescription
event-count-fieldfield (string)Output field containing the number of events in the session.
Examples: data_field
duration-fieldfield (string)Output field containing the session duration in milliseconds.
Examples: data_field
numeric-fieldsTransaction Session Numeric Field[]Numeric fields to summarise with the configured operations.

Transaction Session Summary - Transaction Session Numeric Field - Transaction Session Metric Operation Options

ValueNameDescription
minminMin
maxmaxMax
sumsumSum
meanmeanMean
stddevstddevStddev