Report Custom Issues in iOS Apps

Manual Reporting: Use the single-line API to report anticipated issues and logic failures.

Type: 1 | Severity: Minor (see severity)

Appxiom iOS framework allows you to report custom issues that can be anticipated in your app. By using the ReportIssue API, you can log specific errors or failure scenarios, making it easier to diagnose and resolve problems that may not be automatically detected.

What is Custom Issue Reporting?

• Manual Error Logging: Report issues that you can anticipate in your app logic.
• Flexible API: Use the ReportIssue API anywhere in your codebase.
• Activity Marker Integration: Add activity markers to provide context for each reported issue.
• Minor Severity: Custom issues are reported with Minor severity by default.

Reporting a Custom Issue

Call the ReportIssueAt API wherever you anticipate a failure or error. You can also set an activity marker for additional context.

Objective C

// Payment gateway delegate methods.
-(void) paymentCompleted:(NSString *) userIdentifier forType:(NSInteger) type{
    // ...
}

-(void) paymentFailed:(NSString *) userIdentifier forReason:(NSString *) reason{
    [Ax setActivityMarkerAt:self marker:[NSString stringWithFormat:@"User id %@", userIdentifier]];
    [Ax reportIssueAt:self withShortDescription:@"Payment failed" withDescription:reason];
}

Swift

// Payment gateway delegate methods.
func paymentCompleted(_ userIdentifier: String, _ type: String) {
    // ...
}

func paymentFailed(_ reason: String, _ userId: String) {
    Ax.setActivityMarkerAt(self, marker: String(format: "User Id %@", userId))
    Ax.reportIssue(at: self, withShortDescription: "Payment failed", withDescription: reason)
}

• Anywhere in your project: Use this API wherever you anticipate a failure or want to log a custom issue.
• Pass descriptive strings: Provide a short description and detailed reason for the issue.
• Combine with activity markers: Use activity markers to add context and aid in reproducing the issue.

Best Practices

• Use custom issue reporting for anticipated errors, not for logging.
• Add activity markers for better traceability
• Provide clear and concise descriptions for each issue
• Regularly review custom issues in the Appxiom dashboard
• Document custom issue reporting logic for your team

Frequently Asked Questions (FAQ)

Q: What is the purpose of custom issue reporting?
A: It allows you to manually report anticipated errors or failure scenarios that may not be automatically detected by the framework.

Q: Where can I use the ReportIssueAt API?
A: You can use it anywhere in your codebase where you want to report an issue.

Q: What severity is assigned to custom issues?
A: Custom issues are reported with Minor severity by default. But this can be overridden in the reportIssue API call.

Q: Can I add context to custom issues?
A: Yes, use activity markers to provide additional context for each reported issue.

Q: Can I use this API in both Objective-C and Swift?
A: Yes, the API is available for both Objective-C and Swift projects.

Q: Can I pass parameters to the custom issue report?
A: Yes, you can pass descriptive strings as parameters to provide details about the issue.

Q: Can I change the severity of a custom issue?
A: The default severity is Minor, but this can be overridden in the reportIssue API call itself.