The Celigo platform includes a set of advanced features designed to help you analyze integration flow runs and manage the system exceptions that can occur. The error management features include dashboards to help you quickly understand how your integrations are performing, as well as tools to help you find and resolve errors.
Contents
- Video walkthroughs
- View details for running and completed flows
- View a running flow and the run history
- Receive error notification emails
- Analyze flow metrics
- Access errors via API
Video walkthroughs
Using dashboards
Investigating errors for a flow
View details for running and completed flows
You can see information about running flows and the results of completed flows in two locations:
- Account Dashboard: Click Dashboard on the left navigation menu to see details for all flows. You can filter by integration or other criteria as needed.
- Integration Dashboard: Within an integration, click the Dashboard tab to see the same information specific to that integration only.
Dashboard – Running flows tab showing flows in progress
Dashboard – Completed flows tab showing results
(While the run statistics are calculated for the selected Completed date range,
the Open errors count always contains the historical total for a completed flow.)
Tip: You can select an option under My Account settings to specify relative time display across all dashboards and resource tables instead of the absolute time, which is the default. (For example, to see that a run completed “4 hours ago” instead of 2022-02-10 3:30:02 PM, enable this option.) This system-wide setting can be set separately for each user. See Manage your profile for more information.
View a running flow and the run history
Run console: You can watch a flow as it's running and access the errors as they are reported (even before the flow run has completed) using the Run console. From within an integration, click a specific flow. The top half of the page shows the flow configuration, and the Run console appears on the first tab below. You can see detailed information for each step in the flow as it runs.
Note: The Run console reflects the status of the most recent run or the run currently in progress. If you begin to resolve errors, this is NOT reflected in the error counts.
Run history: For detailed information on past runs, use the Run history. It appears as a tab beneath the flow configuration when you're viewing a specific flow. You can also access it anytime from the Account Dashboard or Integration Dashboard when you are viewing Completed flows. Simply click the number in the Runs column for a specific flow to view its Run history, and expand the rows as needed to view details for each step of the flow.
The Run history displays run results for the last 1,000 runs, or however long your data retention plan allows. It is important to keep in mind that the Run history contains a snapshot of the flow’s results and will not be updated. For example, if you ran a flow a month ago with 100 errors and resolved 100 errors, the Run history still reflects that the run produced 100 errors.
In the Run console and Run history, you can view the color-coded status of flow runs. The status can be completed successfully, completed with errors, canceled, or failed. If the status of a flow run is Canceled, you can click the info icon next to it and view who canceled the flow.
Filtering the run history
Several options make it easier to focus on the history items you're interested in:
- Select range: Choose one of the set time ranges, such as Last 7 Days, or set a custom range to see only the runs that occurred during that period.
- Select status: Filter the history to see only runs that were completed, only runs containing errors, or other options.
- Hide empty runs: Exclude all jobs without records (i.e. Success, Ignored, and Errors columns are all 0).
Receive error notification emails
Integrator.io checks for new and newly resolved errors every 15 minutes, then sends any necessary email notifications with a summary of new, resolved, and open errors, along with error details.
An account owner can subscribe to email error alerts within Flow Builder, as well as sign up other users to receive the notifications.
Note: If you have integrations in both sandbox and production environments, you must subscribe to notifications separately in each environment. When an error notification is sent from the sandbox, then "sandbox" is mentioned in the subject line.
Analyze flow metrics
Use the Analytics tab within an integration to view errors, successes, ignores, and average processing time per successful record over time in visual charts. This can help you spot patterns or trends, and take action accordingly.
Use the selection button on the top right to select up to eight data streams to include in the charts (for example, one integration-level data stream, and seven individual flows' data streams).
The charts summarize the results of flow runs that occurred in the timespan you select:
- Last 4 hours or less: Results displayed within a minute interval
- 4 hours to 4 days: Results displayed within an hourly interval
- More than 4 days: Results displayed within a daily time interval
Note: Although you can view the flow statistics for the past year, the error retry data is available for each flow step only for however long your data retention plan allows, or the most recent 20,000 errors, whichever occurs first.
Access errors via API
With Error Management, you can access your flows’ errors using the integrator.io API and then take action programmatically. Full access tokens are required for authentication.
https://api.integrator.io/v1/flows/<_flowid>/<_exportId || _importId>/errors
GET
https://api.integrator.io/v1/flows/<_flowid>/<_importId>/resolved
PUT
Request body: { "errors": ["<_errorId1>", ... , "<_errorIdn>"]}
https://api.integrator.io/v1/flows/<_flowid>/<_importId>/retry
POST
Request body: { "retryDataKeys": ["<_retryDataKey1>", ... , "<_retryDataKeyn>"]}
When making a GET method call, you can add the following query parameters to this API to narrow down the results you want to see:
- occurredAt_lte (time value is UTC in ISO format)
- occurredAt_gte (time value is UTC in ISO format)
- Source
An /errors API call can return up to 1,000 error records; use pagination to fetch the next 1,000.
A template available in the Marketplace demonstrates error handling automation via the integrator.io errors REST API. The Error automation via integrator.io APIs template contains two example flows that use Error Management features to automate retrying or resolving errors that meet certain conditions. This template is most useful for integration scenarios where errors do not need further resolution other than to retry the record as-is or for known issues that can be automatically resolved.
For example, you could use the API within a routine or integration that displayed errors for a specific flow on Slack. Then, team members in Slack could mark these errors as resolved or retry them.
Comments
6 comments
We are rolling this new error management framework in phases. So, please leave a comment here if you are interested in migrating to the new error management sooner rather than later.
As a reminder, if your account has Integration App (IA) or IA license or you plan to use IA, you'll need to wait till Feb 2021 to uptake the new features.
Thanks
Hi,
My flow doesn't give any errors, it just returns empty fields. How to troubleshoot that?
-Anna
Anna Orlova
I verified that your integrator.io account is not on the new error management. However, please raise a support ticket so they can discuss with you to better understand what fields are empty and then assist you with your questions.
Thank you
I'd love to be able to jump right into a data flows' errors. With this new dashboard, its adds a click because it shows a breakdown of the steps. I guess "parent jobs" is no longer a concept. Top video [Using Dashboards], 29 second mark. Just something I'll have to get used to. Love the product!
Hey,
I was working on Automatic resolve error by using trace key. So it worked fine.
But when i need again to go back on previous stage like i don't want to resolve error so i turned it off from setting.
Actually the problem arises when process is still resolving error and not showing latest errors in error log.
So please check it, if there is any situation please response.
Anuj kumar Maurya
I suggest that you log a case with support outlining steps to reproduce your scenario, what the problem is and what your expected result is. When the Auto-resolve errors is turned off, then integrator.io will not auto-resolve the errors.
Thanks
Please sign in to leave a comment.