Use BatchApexErrorEvent Triggers to Monitor ISV Applications With Example (Salesforce Spring ’21 Release)

Include BatchApexErrorEvent triggers in your managed package to monitor the health of batch jobs and take necessary corrective action without any post-installation steps.

Where: This change applies to Lightning Experience and Salesforce Classic.

How: The BatchApexErrorEvent object represents a platform event associated with a failing batch Apex execution. To fire this platform event, a batch Apex class declaration must implement the Database.RaisesPlatformEvents interface. A BatchApexErrorEvent platform event is fired when a batch Apex job encounters an unhandled exception. For more details, see Firing Platform Events from Batch Apex in the Apex Developer Guide.

The BatchApexErrorEvent object represents a platform event associated with a batch Apex class. This object is available in API version 44.0 and later. If the start, execute, or finish method of a batch Apex job encounters an unhandled exception, a BatchApexErrorEvent platform event is fired. For more details, see BatchApexErrorEvent.

To fire a platform event, a batch Apex class declaration must implement the Database.RaisesPlatformEvents interface.

1. public with sharing class YourSampleBatchJob implements Database.Batchable<SObject>,
2. Database.RaisesPlatformEvents{
3. // class implementation
4. }

Example

This example creates a trigger to determine which accounts failed in the batch transaction. Custom field Dirty__c indicates that the account was one of a failing batch and ExceptionType__c indicates the exception that was encountered. JobScope and ExceptionType are fields in the BatchApexErrorEvent object.

1. trigger MarkDirtyIfFail on BatchApexErrorEvent (after insert) {
2. Set<Id> asyncApexJobIds = new Set<Id>();
3. for(BatchApexErrorEvent evt:Trigger.new){
4. asyncApexJobIds.add(evt.AsyncApexJobId);
5. }
7. Map<Id,AsyncApexJob> jobs = new Map<Id,AsyncApexJob>(
8. [SELECT id, ApexClass.Name FROM AsyncApexJob WHERE Id IN :asyncApexJobIds]
9. );
11. List<Account> records = new List<Account>();
12. for(BatchApexErrorEvent evt:Trigger.new){
13. //only handle events for the job(s) we care about
14. if(jobs.get(evt.AsyncApexJobId).ApexClass.Name == 'AccountUpdaterJob'){
15. for (String item : evt.JobScope.split(',')) {
16. Account a = new Account(
17. Id = (Id)item,
18. ExceptionType__c = evt.ExceptionType,
19. Dirty__c = true
20. );
21. records.add(a);
22. }
23. }
24. }
25. update records;
26. }