PLCrashReporter

To use PLCrashReporter in Objective-C, import the module, configure the signal handler and symbolication strategy, and enable the reporter. Note that enabling in-process crash reporting may conflict with attached debuggers.

@import CrashReporter;

// Configure: Use PLCrashReporterSignalHandlerTypeMach and a symbolication strategy
// Use PLCrashReporterSymbolicationStrategyNone for release versions.
PLCrashReporterConfig *config = [[PLCrashReporterConfig alloc] initWithSignalHandlerType: PLCrashReporterSignalHandlerTypeMach
                                                                   symbolicationStrategy: PLCrashReporterSymbolicationStrategyAll];
PLCrashReporter *crashReporter = [[PLCrashReporter alloc] initWithConfiguration: config];

// Enable the Crash Reporter.
NSError *error;
if (![crashReporter enableCrashReporterAndReturnError: &error]) {
    NSLog(@"Warning: Could not enable crash reporter: %@", error);
}

// Checking for and processing a pending report
if ([crashReporter hasPendingCrashReport]) {
    NSData *data = [crashReporter loadPendingCrashReportDataAndReturnError: &error];
    if (data != nil) {
        PLCrashReport *report = [[PLCrashReport alloc] initWithData: data error: &error];
        if (report != nil) {
            NSString *text = [PLCrashReportTextFormatter stringValueForCrashReport: report withTextFormat: PLCrashReportTextFormatiOS];
            NSLog(@"%@", text);
        }
    }
    [crashReporter purgePendingCrashReport];
}

To use PLCrashReporter in Swift, import the module, create a configuration, and initialize the reporter. It is recommended to use [] for symbolication strategy in release versions.

import CrashReporter

// Configure: Use .mach signal handler and .all symbolication strategy
// Use [] for release versions.
let config = PLCrashReporterConfig(signalHandlerType: .mach, symbolicationStrategy: .all)
guard let crashReporter = PLCrashReporter(configuration: config) else {
    print("Could not create an instance of PLCrashReporter")
    return
}

// Enable the Crash Reporter.
do {
    try crashReporter.enableAndReturnError()
} catch let error {
    print("Warning: Could not enable crash reporter: \(error)")
}

// Checking for and processing a pending report
if crashReporter.hasPendingCrashReport() {
    do {
        let data = try crashReporter.loadPendingCrashReportDataAndReturnError()
        let report = try PLCrashReport(data: data)

        if let text = PLCrashReportTextFormatter.stringValue(for: report, with: PLCrashReportTextFormatiOS) { 
            print(text)
        } else {
            print("CrashReporter: can't convert report to text")
        }
    } catch let error {
        print("CrashReporter failed to load and parse with error: \(error)")
    }
    crashReporter.purgePendingCrashReport()
}