Run logs & queue

Introduction

The run logs page is used to access detailed logs and payloads for active and previous process flow runs and also your run queue:

  • Run logs are retained for 7 days.

  • Payloads are retained for 72 hours.

  • Payloads are stored in AWS S3 (eu-west-2 London).

  • Payloads are encrypted during any pull/push operations (HTTPS, TLS 1.2/1.3).

Accessing your run logs & queue

To access retrospective run logs, follow the steps below.

Step 1 Log into the Patchworks dashboard and select run logs from the left-hand navigation menu:

Step 2 Select the active tab for active and previous runs or the queue tab for pending runs:

Working with run logs

The active tab displays active and previous process flow runs - these are listed chronologically based on the run start time:

At a glance, you can see the outcome of a run, the start date/time, the duration, and how the run was triggered. Failed runs are shown with an expandable summary of why the run failed, and a view logs option is available for each entry so that you can access detailed logs and payloads.

If a process flow is running it is displayed with a 'stop' button that you can use to stop the run.

Need to know

  • Run logs are retained for 7 days.

  • Payloads are retained for 72 hours.

  • Payloads are stored in AWS S3 (eu-west-2 London).

  • Payloads are encrypted during pull/push operations (HTTPS, TLS 1.2/1.3).

The default view

By default, logs are displayed for the last seven days. You can change this using the associated date filter - here, you can clear all filters to show all available logs, or choose a new date/time range:

Filters

Use filters to refine the list based on the value associated with a particular column. Currently, you can filter logs by:

  • Date

  • Status

  • Trigger (schedule, manual, API, etc.)

To define a filter, click the filter icon associated with a column - for example:

...then make selections from the options provided - for example, the date filter displays date/time pickers:

Run status

The status of a run will be one of the following:

StatusSummary

Success

The process run completed without errors.

Failed

The process run did not complete due to errors.

Stopped

The process flow was stopped manually.

Running

The process flow is currently running.

View logs

Click the hamburger icon associated with a run log entry to access detailed logs and payloads:

Here, you can scroll down the page to view information for each step of the process flow:

Click the 'eye' icon to view the associated payload(s) for a log item:

Any associated payloads are available for selection:

Payloads are available for 72 hours after the process flow has run.

If a payload is too large to display it is trimmed and a download payload option is available for offline viewing.

Downloading run logs

For information about downloading run logs, please see our Downloading run logs page.

Checking the reason for a failed run

Run logs can contain a lot of information and there may be times when you just want to quickly see the reason a run has failed.

When a process flow run is initialised but fails somewhere in the run, its status is set to failed and an expandable arrow is shown to the left of the entry - click this arrow to view a summary of why the failure occurred. For example:

Retrying a failed run

If a run entry shows as failed, it is displayed with a retry button - for example:

You can click this to try the run again. This run job is then added to the queue, to be processed as soon as possible.

When this option is used, the flow version that was set originally is used. If you want to run an updated version of the process flow, you can choose to edit the flow and initialise a run manually instead.

If a process flow includes references to variables, be aware that any values for those variables may not be the same as they would have been if the failed flow had been successful.

Working with your run queue

When a job is triggered to run (either manually, or via a trigger/webhook/inbound API call), the run job is placed in a queue for processing. You can view all of your pending runs from the queue tab - entries are listed chronologically based on the time that the job was added to the queue:

At a glance, you can see the run id, process flow version id, how the run was triggered, the status, and the date/time that the run job was created/updated.

As soon as a pending job starts running, the entry is removed from this table and moves to the active run logs section.

The created date/time is the date and time that the run was added to the queue. Since we are only considering pending items, the created and updated date/time will always be the same.

Queue status

The status of a queue entry will always be set to pending.

Need to know

There is a limit on the number of process flow runs that can be started per minute. This limit varies according to your subscription tier - please see Core subscription tiers for information.

Last updated