Report handled exceptions

At times, you might expect your app to throws exceptions. When you handle those exceptions with a try-catch block, you can use the Splunk MINT exception handling feature to keep track of any exceptions your app throws and catches. Splunk MINT can also collect customized data associated with an exception. The Splunk MINT exception handling feature applies only to exceptions your application throws rather than to any app crashes that might occur. Use this to your advantage to create self-explanatory exceptions.

• To log an exception with an extra key-value pair, use the logExceptionAsync:extraDataKey:extraDataValue: method.
• To log an exception with an extra data list, use the logExceptionAsync:limitedExtraDataList: method.
• To log an exception with no extra data, use the logExceptionAsync:limitedExtraDataList: method, but pass nil in the limitedExtraData: parameter.
• As an alternative to the previous methods, you can use use the MintLogException(NSException, LimitedExtraDataList) macro to post an exception and its stacktrace along with optional extra data to identify it, as follows:

// Objective-C

LimitedExtraDataList* limitedExtraData = [LimitedExtraDataList new];
[limitedExtraData add:[[ExtraData alloc] initWithKey:@"TestKey1" andValue:@"TestValue1"]];
@try
{
    NSArray* twoObjsArray = @[@"1", @"2"];
    NSString* objNotExist = [twoObjsArray objectAtIndex:3];
    NSLog(@"%@", [objNotExist description]);
}
@catch (NSException *exception)
{
    MintLogException(exception, limitedExtraData);
    // or if you don't need to attach any extra data
    // MintLogException(exception, nil);
}

The MintLogException macro is a shorthand of the logExceptionAsync:limitedExtraDataList:completionBlock: method, used as follows:

LimitedExtraDataList* limitedExtraData = [LimitedExtraDataList new];
[limitedExtraData add:[[ExtraData alloc] initWithKey:@"TestKey1" andValue:@"TestValue1"]];
@try
{
    NSArray* twoObjsArray = @[@"1", @"2"];
    NSString* objNotExist = [twoObjsArray objectAtIndex:3];
    NSLog(@"%@", [objNotExist description]);
}
@catch (NSException *exception)
{
    [[Mint sharedInstance] logExceptionAsync:exception limitedExtraDataList:limitedExtraData completionBlock:^(MintLogResult *mintLogResult)
    {
        NSString* message = [NSString stringWithFormat:@"Log result: %@", mintLogResult.resultState == 0 ? @"OK" : @"Error"];
        NSLog(@"%@", message);
        NSLog(@"Log exception JSON request: %@", mintLogResult.clientRequest);
    }];
}

Using this method helps debug any problem. To get information about the request in general, add a block implementation and examine the MintLogResult object. You can safely pass nil for a completion block.

To view handled exceptions, go to the Errors dashboard in Splunk MINT Management Console, and click Handled under Exception Type in the list of filters.

Note If you add handling for an exception that was previously displayed in MINT Management Console as a crash, this exception will continue to be displayed as a crash.