iOS 使用 Metrickit 收集崩潰日志

2022-05-11 10:58:11

MetricKit 是蘋果在 iOS13系統開始引入的用來匯總和分析有關異常和崩潰診斷以及電源和性能指標的每個設備的報告。當前市面上的開源框架，如 KSCrash，PLCrashReport 等框架都有一些崩潰不能抓取。

Metrickit 是什么

MetricKit 是蘋果在 iOS13系統開始引入的用來匯總和分析有關異常和崩潰診斷以及電源和性能指標的每個設備的報告。

為什么要用 MetricKit 收集崩潰日志

當前市面上的開源框架，如 KSCrash，PLCrashReport 等框架都有一些崩潰不能抓取;比如PLCrashReport 不能抓取棧溢出的崩潰，不能抓取SIGKILL， SIGQUIT等信號量的崩潰。KSCrash 對SIGKILL的崩潰抓取也只能抓取一部分

Metrickit 缺陷

目前只支持 iOS14 以后的崩潰日志收集
崩潰日志沒有返回具體的崩潰時間和啟動時間，崩潰場景信息除了堆棧外沒有其余信息
如果使用了段遷移編譯技術，主程序 macho 的地址和 uuid 無法匹配。

iOS14的崩潰日志是24小時會回調通知一次，時效性低;iOS15 之后，崩潰日志會在下次啟動之后就返回，但經驗證，有的會立即回調，有的則不然，規律不可琢磨

開始接入

1.添加 MetricKit

2.添加 MetricKit 監聽者

if (@available(iOS 14.0, *)) {

        MXMetricManager *manager = [MXMetricManager sharedManager];

        if (self && manager && [manager respondsToSelector:@selector(addSubscriber:)]) {

            [manager addSubscriber:self];

        }

    }

3. 監聽者實現 MXMetricManagerSubscriber 協議方法， payloadDic 里面包含著上次本應用發生的崩潰日志堆棧和信息

 // 蘋果如果有數據數據，注冊監聽之后就會回調

- (void)didReceiveDiagnosticPayloads:(NSArray<MXDiagnosticPayload *> * _Nonnull)payloads  API_AVAILABLE(ios(14.0)){

    if (@available(iOS 14.0, *)) {

        for (MXDiagnosticPayload *payload in payloads) {

                NSDictionary *payloadDic = [payload dictionaryRepresentation];

                

            });

        }

    }

}

4.日志組裝關鍵代碼示例

NSArray *callStackRootFrames = [dicFrame  ArrayValueForKey:kMetrkitCallStackRootFramesKey];

            if (callStackRootFrames.count <= 0) {

                continue;

            }

            NSDictionary *dicZero = [callStackRootFrames ObjectAtIndex:0];

            int rootIndex = 0;

            while (dicZero && dicZero.count > 0) {

                NSString *binaryUUID = [dicZero   stringValueForKey:kMetrkitBinaryUUIDKey];

                NSString *binaryName = [dicZero   stringValueForKey:kMetrkitBinaryNameKey];

                long long baseAdd = [[dicZero NumberValueForKey:kMetrkitOffsetIntoBinaryTextSegmentKey] longLongValue];

                long long address = [[dicZero  numberValueForKey:kMetrkitAddressKey] longLongValue];

                NSArray *subFrames = [dicZero  arrayValueForKey:kMetrkitSubFramesKey];

                [strStack appendFormat:@"%d %@ 0x%llx 0x%llx + %lld\n", rootIndex, binaryName, baseAdd, address, address - model.baseAddress];

                rootIndex++;

                if (subFrames && subFrames.count >= 0) {

                    dicZero = [subFrames  ObjectAtIndex:0];

                } else {

                    dicZero = nil;

                }

MetricKit 返回字段含義及詳情

JSON總格式

crashDiagnostics 詳情

每一個崩潰為一個字典，具體內容為下

diagnosticMetaData 字典詳情

|terminationReason|String|崩潰原因| RBSTerminateContext domain:10 code:0x8BADF00D 
explanation:scene-update watchdog transgression: application :6308 
exhausted real (wall clock) time allowance of 10.00 seconds|