Gearset's error monitoring solution helps teams stay on top of Flow and Apex errors in their Salesforce orgs by providing real-time alerts and in-depth analysis of observed error behaviour. With automated tracking and notifications, you can quickly diagnose and resolve Flow and Apex errors, ensuring seamless business processes.
This quick start guide walks through setting up an error monitoring job, configuring notifications, and leveraging filtering and analytics features to gain useful insights.
Creating your error monitoring job
From the main Gearset sidebar menu click on the Observability category.
From the welcome screen, click on
Begin setup. Note: If you've already added a Flow monitoring job, you can create an additional job via theActionsbutton located in the top right of the screen.Choose the Salesforce org you want to monitor for errors.
Give a name for the monitoring job.
Click
Finish setup.
Important: we do not recommend monitoring Sandbox orgs. Once a Sandbox org is refreshed a new org id is created which will break the link between your Salesforce org and the Flow error monitoring job. This will cause the org to no longer be monitored for errors by Gearset.
Gearset will automatically configure the monitoring job for you. See our automated setup guide for more information on how this process works.
We recommend adding additional recipients to ensure that Apex Exception emails are still received.
During setup, you will be prompted to update the Apex Exception Email recipient to use the Gearset-generated email address if one is already not present. Both Flow and Apex error emails will be sent to the Gearset inbox.
Error monitoring results
Error monitoring dashboard
As Flow and Apex errors occur, key performance metrics are plotted on a dashboard giving high visibility of errors. These include:
Plotting of impacted users and errors occurring over any specified time range compared with its historical error rates to track changes over time.
A breakdown of the most common error types being responsible for the Flow errors being generated.
Top 10 worst Flows for errors
Total impacted users and errors
Timeline functionality
Gearset monitors and records errors from the point of the job being created and first error being received. Flow and Apex errors are plotted for chosen time range enabling you to identify trends or spikes in errors to investigate further.
Errors can be filtered by date range with a number of presets or choosing your own custom date range. You can click and drag over the time range for easier selection of a time frame you want to inspect in more detail.
Deployments you've performed with Gearset, either manually or via CI job runs, are also plotted on the timeline.
Free text filtering can search for any Flow or Apex name, element or error type within the results. The timeline will update based on the search results.
Total errors are plotted on the timeline or individually if filtering by Flow or Apex name is applied.
For a more granular analysis, individual Flow and Apex error results can be selected and plotted on the timeline.
Error results
Errors are grouped by the Flow name or Apex category, each of which can be expanded to show the breakdown of error types and instance details.
First seen shows the first time an error report was received within the selected time range. Note: If the monitoring job was created after the selected time range it'll only display the first seen date since the job was created within that range.
Last seen shows the last time an error report was received in the selected time range with job creation date also taken into account when applicable.
Users displays the number of users who triggered the error (current user from the Flow interview).
Error count is the total number of times an error was received.
Expanding a Flow grouping shows a breakdown for that Flow of the different problem types and Flow elements with date, error count, users impacted metrics. Clicking on View errors provides access to the error reports for those errors. The numbers and percentages for errors are in relation to the Flow.
Expanding an Apex category group shows the specific error and namespace/method with further metrics such as date information, number of errors and users impacted count.
Creating notification rules
From the Error details page, click on Add notification rule. You can then add rules to match based on:
Content from the error notification content such as the Flow name, error type, and error content contained within the email.
Threshold/volume based criterion such as the number of errors within a chosen timeframe.
Content or volume based rules can be used in combination or individually.
Flow Navigator integration
Gearset's Flow Navigator feature let's you inspect the Flow that errored alongside the error details enabling you to understand faster where the element sits in your overall Flow, the parent logic and root cause of the error.
Adding Slack and MS Teams notifications
Once a job has been created you can add Slack and MS Teams notifications to receive a channel alert when error occurs. See our adding Slack and MS Teams notifications documentation for step-by-step instructions.
