Interface CorrelationId

Legend

Namespace
Variable
Function
Function with type parameter
Type alias
Type alias with type parameter

Interface
Interface with type parameter
Property

Enumeration

Class

This is data stored in an RStreams queue Event to understand where this event came from before it got into the queue it is in now, whether that's an external system like Mongo or MS SQL Server or whether this event is a derivative event from an upstream queue.

So, let's say that your bot read from Queue A and got event 123 from it. Your bot then transformed event 123 and turned it into some new event that you sent to Queue B as event 789. Your event 789 should keep track of the ancestry of the event, storing here in the correlation information the fact that it came from Queue A, the source, and event 123 in start.

Also note, that sometimes you will have a bot that reads several events from an upstream queue and then writes exactly one aggregate event to a downstream queue. In this case, you want to track the ID of the first upstream event that was aggregated in start and the last aggregated event in end and set units to the number of total events that got turned into this one event.

Developers that don't take the time to add this data to an event. do this will regret it in the future. This information is critical to the trace feature for debugging, both manual tracing to understand where an event came from and botmon's automated visual tracing.

Hierarchy

CorrelationId

Index

Properties

Optional end

end?: string

The ending ID in the parent source this event derived from. If the parent was an RStreams queue, this will be the event ID. This being set means this event derived from multiple events in the parent queue and start is the first and end is the last.

default: start

Optional partial_end

partial_end?: string

Same as end but indicates that the source eid is partial or incomplete. This indicates to the system to NOT checkpoint on this correlation_id Use either end or partial_end but not both

Optional partial_start

partial_start?: string

Same as start but indicates that the source eid is partial or incomplete. This indicates to the system to NOT checkpoint on this correlation_id Use either start or partial_start but not both

source

source: string

Data that identifies the parent source of this data, often the parent RStreams queue name this event derived from or a table in Mongo or a kinesis stream name, etc.

start

start: string

The starting ID in the parent source this event derived from. If the parent was an RStreams queue, this will be the event ID. If the parent was a mongo table this would the Mongo tail position, or if from kinesis this will be the kinesis sequence number, etc. If this event derived from more than one parent event, end will be set.

Optional units

units?: number

If this event is derived from multiple parent events, this is how many.

default: 1