Gearset's Observability solution helps teams stay on top of org limit monitoring, and Flow and Apex errors in their Salesforce orgs by providing real-time alerts and in-depth analysis of observed behaviour.
This quick start guide provides a brief overview of some of the key features to help get you started.
Creating your monitoring job
From the main Gearset sidebar menu click on Observability.
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.
Give the job a name.
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.
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
Key performance metrics are plotted on a dashboard giving high visibility of errors and org limits. 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.
Org limits such as daily API requests, Platform events, email limits and more.
Timeline functionality
Gearset monitors and records Apex and Flow 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.
Deployments you've performed with Gearset, either manually or via CI job runs, are also plotted on the timeline.
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.
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.
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.
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 org limits hit their warning or critical thresholds. See our adding Slack and MS Teams notifications documentation for step-by-step instructions.
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.
Creating and attaching Jira or Azure Work Item tickets
For instructions on setting up your Jira connection see our support ticket documentation.
You can create Jira and/or Work Items tickets and attach them to monitoring errors from within Gearset. From the details page for a specific error click on either Add Jira ticket or Add Azure DevOps ticket.
For Jira, choose the project under which the ticket will be created, add a summary name and description for the ticket.
For Azure, choose the Azure DevOps organization and project, enter a title and description for the project and create your Work Item to finish.