Replay
Leaving replay on for a pipeline in production can degrade pipeline performance as each stage requires disk access to get/save tracked events. We recommend only using this feature for debugging.
Replay Mode
Replay Mode provides detailed information about previous pipeline executions. From the Replay List, recent pipeline executions can be replayed, and individual events can be inspected in detail.
Recording Replays
To start recording Replays, turn on the Track Events feature from the Pipeline Start stage.
When Track Activity is enabled, the last 100 pipeline executions will be stored on disk in a database (intelligencehub-pipeline-activity.db) located in the App Data directory.
After the 100 replay limit is reached, the oldest replay will be deleted. The message “This replay has expired” will be shown when attempting to access a replay that has been deleted.
The replay list can be paused by disabling “Track Events”, this will not delete any saved replays, but will pause the recording of new replays.
Entering Replay Mode
To enter replay mode, click the Replay tool to open the Replay List, then select a replay from the list. Replays can be triggered by:
- Triggers
- Test Writes
- Buffer Stages
- (e.g.) When a Time Buffer expires it will re-trigger the pipeline from that stage.
The name of the trigger that the event originated from is shown in the Trigger column.
When a replay is selected, the view will change to “Replay Mode”.
Using Replay Mode
When in Replay Mode the pipeline graph cannot be edited, and will reflect the exact state of the pipeline when the replay was recorded.
Selecting a stage in Replay Mode will provide detailed information about that stage:
The status of a stage can be easily determined by the appearance of the stage in the graph.
| Status | Description |
|---|---|
| Green Check | All events were processed by the stage successfully |
| Red X | One or more events produced an error |
| Grey background | The stage was never reached. This could be caused if a previous stage produced an error, buffered events, or was stopped programmatically. |
Exiting Replay Mode
Replay mode can be exited by using the “Exit Replay” button in the top center of the graph, or by clicking the Replay Tool and selecting “Exit Replay” on the details card for the selected transaction.
Deleting Replays
Using the “Clear” button in the Replay List will permanently delete all recorded replays for that pipeline.