add_uuid
Generate and add a unique identifier (UUID4) to each event.
Overview
Generate and add a unique identifier (UUID4) to each event. This step creates a fresh UUID4 string for every event that passes through, writing it to a configurable field path. UUIDs are universally unique identifiers that are ideal for request tracking, correlation IDs, idempotency keys, or any scenario where you need to uniquely identify an event across distributed systems. Nested dictionaries are created automatically as needed, and any existing value at the target path is overwritten.
Quick Start
steps:
- type: add_uuidConfiguration
| Parameter | Type | Required | Description |
|---|---|---|---|
output_to | string | No | Dot-delimited path where a new UUID4 string will be written; intermediate dicts are created automatically. Defaults to 'meta.id'.
Default: "meta.id" |
field | string | No | DEPRECATED: Use 'output_to' instead. Dot-delimited path where the UUID will be written. |
Examples
Default UUID generation
Add a UUID to the default meta.id field
type: add_uuid
Request tracking ID
Generate a unique request ID for API calls
type: add_uuid
output_to: request.id
Correlation ID for distributed tracing
Create a correlation ID to track events across multiple services
type: add_uuid
output_to: tracking.correlation_id
Idempotency key for APIs
Generate an idempotency key for safe retries
type: add_uuid
output_to: api.idempotency_key
Advanced Options
These options are available on all steps for error handling and retry logic:
| Parameter | Type | Default | Description |
|---|---|---|---|
retries | integer | 0 | Number of retry attempts (0-10) |
backoff_seconds | number | 0 | Backoff (seconds) applied between retry attempts |
retry_propagate | boolean | false | If True, raise last exception after exhausting retries; otherwise swallow. |