精华内容
下载资源
问答
  • 现在上一个项目,如果没有APM监控服务或应用的运行性能参数,等于是一架没有盲降系统的飞机正在盲降,结果会很悲催。出现了访问失效等问题时,都很难判定是性能瓶颈还是一个藏的深的bug,汇报的时候一顿眼晕,这样的...
  • 带你打造一套 APM 监控系统(一)

    千次阅读 2020-07-14 11:06:31
    APM 是 Application Performance Monitoring 的缩写,监视和管理软件应用程序的性能和可用性。应用性能管理对一个应用的持续稳定运行至关重要。所以这篇文章就从一个 iOS App 的性能管理的纬度谈谈如何精确监控以及...

    声明:尊重原创,原文地址:《带你打造一套 APM 监控系统》。本文为根据原创文章整理所得,感谢浏览。

    APM 是 Application Performance Monitoring 的缩写,监视和管理软件应用程序的性能和可用性。应用性能管理对一个应用的持续稳定运行至关重要。所以这篇文章就从一个 iOS App 的性能管理的纬度谈谈如何精确监控以及数据如何上报等技术点

    App 的性能问题是影响用户体验的重要因素之一。性能问题主要包含:Crash、网络请求错误或者超时、UI 响应速度慢、主线程卡顿、CPU 和内存使用率高、耗电量大等等。大多数的问题原因在于开发者错误地使用了线程锁、系统函数、编程规范问题、数据结构等等。解决问题的关键在于尽早的发现和定位问题。

    本篇文章着重总结了 APM 的原因以及如何收集数据。APM 数据收集后结合数据上报机制,按照一定策略上传数据到服务端。服务端消费这些信息并产出报告。请结合姊妹篇, 总结了如何打造一款灵活可配置、功能强大的数据上报组件。

    一、卡顿监控

    卡顿问题,就是在主线程上无法响应用户交互的问题。影响着用户的直接体验,所以针对 App 的卡顿监控是 APM 里面重要的一环。

    FPS(frame per second)每秒钟的帧刷新次数,iPhone 手机以 60 为最佳,iPad 某些型号是 120,也是作为卡顿监控的一项参考参数,为什么说是参考参数?因为它不准确。先说说怎么获取到 FPS。CADisplayLink 是一个系统定时器,会以帧刷新频率一样的速率来刷新视图。 [CADisplayLink displayLinkWithTarget:self selector:@selector(###:)]。至于为什么不准我们来看看下面的示例代码

    _displayLink = [CADisplayLink displayLinkWithTarget:self selector:@selector(p_displayLinkTick:)];
    [_displayLink setPaused:YES];
    [_displayLink addToRunLoop:[NSRunLoop currentRunLoop] forMode:NSRunLoopCommonModes];
    

    代码所示,CADisplayLink 对象是被添加到指定的 RunLoop 的某个 Mode 下。所以还是 CPU 层面的操作,卡顿的体验是整个图像渲染的结果:CPU + GPU。请继续往下看

    1. 屏幕绘制原理

    在这里插入图片描述

    讲讲老式的 CRT 显示器的原理。 CRT 电子枪按照上面方式,从上到下一行行扫描,扫面完成后显示器就呈现一帧画面,随后电子枪回到初始位置继续下一次扫描。为了把显示器的显示过程和系统的视频控制器进行同步,显示器(或者其他硬件)会用硬件时钟产生一系列的定时信号。当电子枪换到新的一行,准备进行扫描时,显示器会发出一个水平同步信号(horizonal synchronization),简称 HSync;当一帧画面绘制完成后,电子枪恢复到原位,准备画下一帧前,显示器会发出一个垂直同步信号(Vertical synchronization),简称 VSync。显示器通常以固定的频率进行刷新,这个固定的刷新频率就是 VSync 信号产生的频率。虽然现在的显示器基本都是液晶显示屏,但是原理保持不变。

    在这里插入图片描述

    通常,屏幕上一张画面的显示是由 CPU、GPU 和显示器是按照上图的方式协同工作的。CPU 根据工程师写的代码计算好需要现实的内容(比如视图创建、布局计算、图片解码、文本绘制等),然后把计算结果提交到 GPU,GPU 负责图层合成、纹理渲染,随后 GPU 将渲染结果提交到帧缓冲区。随后视频控制器会按照 VSync 信号逐行读取帧缓冲区的数据,经过数模转换传递给显示器显示。

    在帧缓冲区只有一个的情况下,帧缓冲区的读取和刷新都存在效率问题,为了解决效率问题,显示系统会引入2个缓冲区,即双缓冲机制。在这种情况下,GPU 会预先渲染好一帧放入帧缓冲区,让视频控制器来读取,当下一帧渲染好后,GPU 直接把视频控制器的指针指向第二个缓冲区。提升了效率。

    目前来看,双缓冲区提高了效率,但是带来了新的问题:当视频控制器还未读取完成时,即屏幕内容显示了部分,GPU 将新渲染好的一帧提交到另一个帧缓冲区并把视频控制器的指针指向新的帧缓冲区,视频控制器就会把新的一帧数据的下半段显示到屏幕上,造成画面撕裂的情况。

    为了解决这个问题,GPU 通常有一个机制叫垂直同步信号(V-Sync),当开启垂直同步信号后,GPU 会等到视频控制器发送 V-Sync 信号后,才进行新的一帧的渲染和帧缓冲区的更新。这样的几个机制解决了画面撕裂的情况,也增加了画面流畅度。但需要更多的计算资源

    在这里插入图片描述

    答疑

    可能有些人会看到「当开启垂直同步信号后,GPU 会等到视频控制器发送 V-Sync 信号后,才进行新的一帧的渲染和帧缓冲区的更新」这里会想,GPU 收到 V-Sync 才进行新的一帧渲染和帧缓冲区的更新,那是不是双缓冲区就失去意义了?

    设想一个显示器显示第一帧图像和第二帧图像的过程。首先在双缓冲区的情况下,GPU 首先渲染好一帧图像存入到帧缓冲区,然后让视频控制器的指针直接直接这个缓冲区,显示第一帧图像。第一帧图像的内容显示完成后,视频控制器发送 V-Sync 信号,GPU 收到 V-Sync 信号后渲染第二帧图像并将视频控制器的指针指向第二个帧缓冲区。

    看上去第二帧图像是在等第一帧显示后的视频控制器发送 V-Sync 信号。是吗?真是这样的吗? 😭 想啥呢,当然不是。 🐷 不然双缓冲区就没有存在的意义了

    揭秘。请看下图:

    在这里插入图片描述

    当第一次 V-Sync 信号到来时,先渲染好一帧图像放到帧缓冲区,但是不展示,当收到第二个 V-Sync 信号后读取第一次渲染好的结果(视频控制器的指针指向第一个帧缓冲区),并同时渲染新的一帧图像并将结果存入第二个帧缓冲区,等收到第三个 V-Sync 信号后,读取第二个帧缓冲区的内容(视频控制器的指针指向第二个帧缓冲区),并开始第三帧图像的渲染并送入第一个帧缓冲区,依次不断循环往复。

    请查看资料,需要梯子:Multiple buffering

    2. 卡顿产生的原因

    在这里插入图片描述

    VSync 信号到来后,系统图形服务会通过 CADisplayLink 等机制通知 App,App 主线程开始在 CPU 中计算显示内容(视图创建、布局计算、图片解码、文本绘制等)。然后将计算的内容提交到 GPU,GPU 经过图层的变换、合成、渲染,随后 GPU 把渲染结果提交到帧缓冲区,等待下一次 VSync 信号到来再显示之前渲染好的结果。在垂直同步机制的情况下,如果在一个 VSync 时间周期内,CPU 或者 GPU 没有完成内容的提交,就会造成该帧的丢弃,等待下一次机会再显示,这时候屏幕上还是之前渲染的图像,所以这就是 CPU、GPU 层面界面卡顿的原因。

    目前 iOS 设备有双缓存机制,也有三缓冲机制,Android 现在主流是三缓冲机制,在早期是单缓冲机制。
    iOS 三缓冲机制例子

    CPU 和 GPU 资源消耗原因很多,比如对象的频繁创建、属性调整、文件读取、视图层级的调整、布局的计算(AutoLayout 视图个数多了就是线性方程求解难度变大)、图片解码(大图的读取优化)、图像绘制、文本渲染、数据库读取(多读还是多写乐观锁、悲观锁的场景)、锁的使用(举例:自旋锁使用不当会浪费 CPU)等方面。开发者根据自身经验寻找最优解(这里不是本文重点)。

    3. APM 如何监控卡顿并上报

    CADisplayLink 肯定不用了,这个 FPS 仅作为参考。一般来讲,卡顿的监测有2种方案:监听 RunLoop 状态回调、子线程 ping 主线程

    3.1 RunLoop 状态监听的方式

    RunLoop 负责监听输入源进行调度处理。比如网络、输入设备、周期性或者延迟事件、异步回调等。RunLoop 会接收2种类型的输入源:一种是来自另一个线程或者来自不同应用的异步消息(source0事件)、另一种是来自预定或者重复间隔的事件。

    RunLoop 状态如下图:

    RunLoop

    第一步:通知 Observers,RunLoop 要开始进入 loop,紧接着进入 loop。

    if (currentMode->_observerMask & kCFRunLoopEntry )
        // 通知 Observers: RunLoop 即将进入 loop
        __CFRunLoopDoObservers(rl, currentMode, kCFRunLoopEntry);
    // 进入loop
    result = __CFRunLoopRun(rl, currentMode, seconds, returnAfterSourceHandled, previousMode);
    

    第二步:开启 do while 循环保活线程,通知 Observers,RunLoop 触发 Timer 回调、Source0 回调,接着执行被加入的 block。

     if (rlm->_observerMask & kCFRunLoopBeforeTimers)
        //  通知 Observers: RunLoop 即将触发 Timer 回调
        __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeTimers);
    if (rlm->_observerMask & kCFRunLoopBeforeSources)
        //  通知 Observers: RunLoop 即将触发 Source 回调
        __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeSources);
    // 执行被加入的block
    __CFRunLoopDoBlocks(rl, rlm);
    

    第三步:RunLoop 在触发 Source0 回调后,如果 Source1 是 ready 状态,就会跳转到 handle_msg 去处理消息。

    //  如果有 Source1 (基于port) 处于 ready 状态,直接处理这个 Source1 然后跳转去处理消息
    if (MACH_PORT_NULL != dispatchPort && !didDispatchPortLastTime) {
    #if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_EMBEDDED_MINI
        msg = (mach_msg_header_t *)msg_buffer;
        
        if (__CFRunLoopServiceMachPort(dispatchPort, &msg, sizeof(msg_buffer), &livePort, 0, &voucherState, NULL)) {
            goto handle_msg;
        }
    #elif DEPLOYMENT_TARGET_WINDOWS
        if (__CFRunLoopWaitForMultipleObjects(NULL, &dispatchPort, 0, 0, &livePort, NULL)) {
            goto handle_msg;
        }
    #endif
    }
    

    第四步:回调触发后,通知 Observers 即将进入休眠状态。

    Boolean poll = sourceHandledThisLoop || (0ULL == timeout_context->termTSR);
    // 通知 Observers: RunLoop 的线程即将进入休眠(sleep)
    if (!poll && (rlm->_observerMask & kCFRunLoopBeforeWaiting)) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeWaiting);
    	__CFRunLoopSetSleeping(rl);
    

    第五步:进入休眠后,会等待 mach_port 消息,以便再次唤醒。只有以下4种情况才可以被再次唤醒。

    • 基于 port 的 source 事件
    • Timer 时间到
    • RunLoop 超时
    • 被调用者唤醒
    do {
        if (kCFUseCollectableAllocator) {
            // objc_clear_stack(0);
            // <rdar://problem/16393959>
            memset(msg_buffer, 0, sizeof(msg_buffer));
        }
        msg = (mach_msg_header_t *)msg_buffer;
        
        __CFRunLoopServiceMachPort(waitSet, &msg, sizeof(msg_buffer), &livePort, poll ? 0 : TIMEOUT_INFINITY, &voucherState, &voucherCopy);
        
        if (modeQueuePort != MACH_PORT_NULL && livePort == modeQueuePort) {
            // Drain the internal queue. If one of the callout blocks sets the timerFired flag, break out and service the timer.
            while (_dispatch_runloop_root_queue_perform_4CF(rlm->_queue));
            if (rlm->_timerFired) {
                // Leave livePort as the queue port, and service timers below
                rlm->_timerFired = false;
                break;
            } else {
                if (msg && msg != (mach_msg_header_t *)msg_buffer) free(msg);
            }
        } else {
            // Go ahead and leave the inner loop.
            break;
        }
    } while (1);
    

    第六步:唤醒时通知 Observer,RunLoop 的线程刚刚被唤醒了。

    // 通知 Observers: RunLoop 的线程刚刚被唤醒了
    if (!poll && (rlm->_observerMask & kCFRunLoopAfterWaiting)) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopAfterWaiting);
        // 处理消息
        handle_msg:;
        __CFRunLoopSetIgnoreWakeUps(rl);
    

    第七步:RunLoop 唤醒后,处理唤醒时收到的消息:

    • 如果是 Timer 时间到,则触发 Timer 的回调
    • 如果是 dispatch,则执行 block
    • 如果是 source1 事件,则处理这个事件
    #if USE_MK_TIMER_TOO
            // 如果一个 Timer 到时间了,触发这个Timer的回调
            else if (rlm->_timerPort != MACH_PORT_NULL && livePort == rlm->_timerPort) {
                CFRUNLOOP_WAKEUP_FOR_TIMER();
                // On Windows, we have observed an issue where the timer port is set before the time which we requested it to be set. For example, we set the fire time to be TSR 167646765860, but it is actually observed firing at TSR 167646764145, which is 1715 ticks early. The result is that, when __CFRunLoopDoTimers checks to see if any of the run loop timers should be firing, it appears to be 'too early' for the next timer, and no timers are handled.
                // In this case, the timer port has been automatically reset (since it was returned from MsgWaitForMultipleObjectsEx), and if we do not re-arm it, then no timers will ever be serviced again unless something adjusts the timer list (e.g. adding or removing timers). The fix for the issue is to reset the timer here if CFRunLoopDoTimers did not handle a timer itself. 9308754
                if (!__CFRunLoopDoTimers(rl, rlm, mach_absolute_time())) {
                    // Re-arm the next timer
                    __CFArmNextTimerInMode(rlm, rl);
                }
            }
    #endif
            //  如果有dispatch到main_queue的block,执行block
            else if (livePort == dispatchPort) {
                CFRUNLOOP_WAKEUP_FOR_DISPATCH();
                __CFRunLoopModeUnlock(rlm);
                __CFRunLoopUnlock(rl);
                _CFSetTSD(__CFTSDKeyIsInGCDMainQ, (void *)6, NULL);
    #if DEPLOYMENT_TARGET_WINDOWS
                void *msg = 0;
    #endif
                __CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__(msg);
                _CFSetTSD(__CFTSDKeyIsInGCDMainQ, (void *)0, NULL);
                __CFRunLoopLock(rl);
                __CFRunLoopModeLock(rlm);
                sourceHandledThisLoop = true;
                didDispatchPortLastTime = true;
            }
            // 如果一个 Source1 (基于port) 发出事件了,处理这个事件
            else {
                CFRUNLOOP_WAKEUP_FOR_SOURCE();
                
                // If we received a voucher from this mach_msg, then put a copy of the new voucher into TSD. CFMachPortBoost will look in the TSD for the voucher. By using the value in the TSD we tie the CFMachPortBoost to this received mach_msg explicitly without a chance for anything in between the two pieces of code to set the voucher again.
                voucher_t previousVoucher = _CFSetTSD(__CFTSDKeyMachMessageHasVoucher, (void *)voucherCopy, os_release);
    
                CFRunLoopSourceRef rls = __CFRunLoopModeFindSourceForMachPort(rl, rlm, livePort);
                if (rls) {
    #if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_EMBEDDED_MINI
    		mach_msg_header_t *reply = NULL;
    		sourceHandledThisLoop = __CFRunLoopDoSource1(rl, rlm, rls, msg, msg->msgh_size, &reply) || sourceHandledThisLoop;
    		if (NULL != reply) {
    		    (void)mach_msg(reply, MACH_SEND_MSG, reply->msgh_size, 0, MACH_PORT_NULL, 0, MACH_PORT_NULL);
    		    CFAllocatorDeallocate(kCFAllocatorSystemDefault, reply);
    		}
    #elif DEPLOYMENT_TARGET_WINDOWS
                    sourceHandledThisLoop = __CFRunLoopDoSource1(rl, rlm, rls) || sourceHandledThisLoop;
    #endif
    

    第八步:根据当前 RunLoop 状态判断是否需要进入下一个 loop。当被外部强制停止或者 loop 超时,就不继续下一个 loop,否则进入下一个 loop。

    if (sourceHandledThisLoop && stopAfterHandle) {
        // 进入loop时参数说处理完事件就返回
        retVal = kCFRunLoopRunHandledSource;
        } else if (timeout_context->termTSR < mach_absolute_time()) {
            // 超出传入参数标记的超时时间了
            retVal = kCFRunLoopRunTimedOut;
    } else if (__CFRunLoopIsStopped(rl)) {
            __CFRunLoopUnsetStopped(rl);
        // 被外部调用者强制停止了
        retVal = kCFRunLoopRunStopped;
    } else if (rlm->_stopped) {
        rlm->_stopped = false;
        retVal = kCFRunLoopRunStopped;
    } else if (__CFRunLoopModeIsEmpty(rl, rlm, previousMode)) {
        // source/timer一个都没有
        retVal = kCFRunLoopRunFinished;
    }
    

    完整且带有注释的 RunLoop 代码见此处。 Source1 是 RunLoop 用来处理 Mach port 传来的系统事件的,Source0 是用来处理用户事件的。收到 Source1 的系统事件后本质还是调用 Source0 事件的处理函数。

    在这里插入图片描述

    RunLoop 6个状态

    
    typedef CF_OPTIONS(CFOptionFlags, CFRunLoopActivity) {
        kCFRunLoopEntry ,           // 进入 loop
        kCFRunLoopBeforeTimers ,    // 触发 Timer 回调
        kCFRunLoopBeforeSources ,   // 触发 Source0 回调
        kCFRunLoopBeforeWaiting ,   // 等待 mach_port 消息
        kCFRunLoopAfterWaiting ),   // 接收 mach_port 消息
        kCFRunLoopExit ,            // 退出 loop
        kCFRunLoopAllActivities     // loop 所有状态改变
    }
    

    RunLoop 在进入睡眠前的方法执行时间过长而导致无法进入睡眠,或者线程唤醒后接收消息时间过长而无法进入下一步,都会阻塞线程。如果是主线程,则表现为卡顿。

    一旦发现进入睡眠前的 KCFRunLoopBeforeSources 状态,或者唤醒后 KCFRunLoopAfterWaiting,在设置的时间阈值内没有变化,则可判断为卡顿,此时 dump 堆栈信息,还原案发现场,进而解决卡顿问题。

    开启一个子线程,不断进行循环监测是否卡顿了。在 n 次都超过卡顿阈值后则认为卡顿了。卡顿之后进行堆栈 dump 并上报(具有一定的机制,数据处理在下一 part 讲)。

    WatchDog 在不同状态下具有不同的值:

    • 启动(Launch):20s
    • 恢复(Resume):10s
    • 挂起(Suspend):10s
    • 退出(Quit):6s
    • 后台(Background):3min(在 iOS7 之前可以申请 10min;之后改为 3min;可连续申请,最多到 10min)

    卡顿阈值的设置的依据是 WatchDog 的机制。APM 系统里面的阈值需要小于 WatchDog 的值,所以取值范围在 [1, 6] 之间,业界通常选择3秒。

    通过 long dispatch_semaphore_wait(dispatch_semaphore_t dsema, dispatch_time_t timeout) 方法判断是否阻塞主线程,Returns zero on success, or non-zero if the timeout occurred. 返回非0则代表超时阻塞了主线程。

    在这里插入图片描述

    可能很多人纳闷 RunLoop 状态那么多,为什么选择 KCFRunLoopBeforeSources 和 KCFRunLoopAfterWaiting?因为大部分卡顿都是在 KCFRunLoopBeforeSources 和 KCFRunLoopAfterWaiting 之间。比如 Source0 类型的 App 内部事件等

    Runloop 检测卡顿流程图如下:

    在这里插入图片描述

    关键代码如下:

    // 设置Runloop observer的运行环境
    CFRunLoopObserverContext context = {0, (__bridge void *)self, NULL, NULL};
    // 创建Runloop observer对象
    _observer = CFRunLoopObserverCreate(kCFAllocatorDefault,
                                        kCFRunLoopAllActivities,
                                        YES,
                                        0,
                                        &runLoopObserverCallBack,
                                        &context);
    // 将新建的observer加入到当前thread的runloop
    CFRunLoopAddObserver(CFRunLoopGetMain(), _observer, kCFRunLoopCommonModes);
    // 创建信号
    _semaphore = dispatch_semaphore_create(0);
    
    __weak __typeof(self) weakSelf = self;
    // 在子线程监控时长
    dispatch_async(dispatch_get_global_queue(0, 0), ^{
        __strong __typeof(weakSelf) strongSelf = weakSelf;
        if (!strongSelf) {
            return;
        }
        while (YES) {
            if (strongSelf.isCancel) {
                return;
            }
            // N次卡顿超过阈值T记录为一次卡顿
            long semaphoreWait = dispatch_semaphore_wait(self->_semaphore, dispatch_time(DISPATCH_TIME_NOW, strongSelf.limitMillisecond * NSEC_PER_MSEC));
            if (semaphoreWait != 0) {
                if (self->_activity == kCFRunLoopBeforeSources || self->_activity == kCFRunLoopAfterWaiting) {
                    if (++strongSelf.countTime < strongSelf.standstillCount){
                        continue;
                    }
                    // 堆栈信息 dump 并结合数据上报机制,按照一定策略上传数据到服务器。堆栈 dump 会在下面讲解。数据上报会在 [打造功能强大、灵活可配置的数据上报组件](https://github.com/FantasticLBP/knowledge-kit/blob/master/Chapter1%20-%20iOS/1.80.md) 讲
                }
            }
            strongSelf.countTime = 0;
        }
    });
    

    3.2 子线程 ping 主线程监听的方式

    开启一个子线程,创建一个初始值为0的信号量、一个初始值为 YES 的布尔值类型标志位。将设置标志位为 NO 的任务派发到主线程中去,子线程休眠阈值时间,时间到后判断标志位是否被主线程成功(值为 NO),如果没成功则认为主线程发生了卡顿情况,此时 dump 堆栈信息并结合数据上报机制,按照一定策略上传数据到服务器。数据上报会在 打造功能强大、灵活可配置的数据上报组件

    while (self.isCancelled == NO) {
            @autoreleasepool {
                __block BOOL isMainThreadNoRespond = YES;
                
                dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
                
                dispatch_async(dispatch_get_main_queue(), ^{
                    isMainThreadNoRespond = NO;
                    dispatch_semaphore_signal(semaphore);
                });
                
                [NSThread sleepForTimeInterval:self.threshold];
                
                if (isMainThreadNoRespond) {
                    if (self.handlerBlock) {
                        self.handlerBlock(); // 外部在 block 内部 dump 堆栈(下面会讲),数据上报
                    }
                }
                
                dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
            }
        }
    

    4. 堆栈 dump

    方法堆栈的获取是一个麻烦事。理一下思路。[NSThread callStackSymbols] 可以获取当前线程的调用栈。但是当监控到卡顿发生,需要拿到主线程的堆栈信息就无能为力了。从任何线程回到主线程这条路走不通。先做个知识回顾。

    在计算机科学中,调用堆栈是一种栈类型的数据结构,用于存储有关计算机程序的线程信息。这种栈也叫做执行堆栈、程序堆栈、控制堆栈、运行时堆栈、机器堆栈等。调用堆栈用于跟踪每个活动的子例程在完成执行后应该返回控制的点。

    维基百科搜索到 “Call Stack” 的一张图和例子,如下:

    在这里插入图片描述

    上图表示为一个栈。分为若干个栈帧(Frame),每个栈帧对应一个函数调用。下面蓝色部分表示 DrawSquare 函数,它在执行的过程中调用了 DrawLine 函数,用绿色部分表示。

    可以看到栈帧由三部分组成:函数参数、返回地址、局部变量。比如在 DrawSquare 内部调用了 DrawLine 函数:第一先把 DrawLine 函数需要的参数入栈;第二把返回地址(控制信息。举例:函数 A 内调用函数 B,调用函数B 的下一行代码的地址就是返回地址)入栈;第三函数内部的局部变量也在该栈中存储。

    栈指针 Stack Pointer 表示当前栈的顶部,大多部分操作系统都是栈向下生长,所以栈指针是最小值。帧指针 Frame Pointer 指向的地址中,存储了上一次 Stack Pointer 的值,也就是返回地址。

    大多数操作系统中,每个栈帧还保存了上一个栈帧的帧指针。因此知道当前栈帧的 Stack Pointer 和 Frame Pointer 就可以不断回溯,递归获取栈底的帧。

    接下来的步骤就是拿到所有线程的 Stack Pointer 和 Frame Pointer。然后不断回溯,还原案发现场。

    5. Mach Task 知识

    Mach task:

    App 在运行的时候,会对应一个 Mach Task,而 Task 下可能有多条线程同时执行任务。《OS X and iOS Kernel Programming》 中描述 Mach Task 为:任务(Task)是一种容器对象,虚拟内存空间和其他资源都是通过这个容器对象管理的,这些资源包括设备和其他句柄。简单概括为:Mack task 是一个机器无关的 thread 的执行环境抽象。

    作用: task 可以理解为一个进程,包含它的线程列表。

    结构体:task_threads,将 target_task 任务下的所有线程保存在 act_list 数组中,数组个数为 act_listCnt

    kern_return_t task_threads
    (
      task_t traget_task,
      thread_act_array_t *act_list,                     //线程指针列表
      mach_msg_type_number_t *act_listCnt  //线程个数
    )
    

    thread_info:

    kern_return_t thread_info
    (
      thread_act_t target_act,
      thread_flavor_t flavor,
      thread_info_t thread_info_out,
      mach_msg_type_number_t *thread_info_outCnt
    );
    

    如何获取线程的堆栈数据:

    系统方法 kern_return_t task_threads(task_inspect_t target_task, thread_act_array_t *act_list, mach_msg_type_number_t *act_listCnt); 可以获取到所有的线程,不过这种方法获取到的线程信息是最底层的 mach 线程

    对于每个线程,可以用 kern_return_t thread_get_state(thread_act_t target_act, thread_state_flavor_t flavor, thread_state_t old_state, mach_msg_type_number_t *old_stateCnt); 方法获取它的所有信息,信息填充在 _STRUCT_MCONTEXT 类型的参数中,这个方法中有2个参数随着 CPU 架构不同而不同。所以需要定义宏屏蔽不同 CPU 之间的区别。

    _STRUCT_MCONTEXT 结构体中,存储了当前线程的 Stack Pointer 和最顶部栈帧的 Frame pointer,进而回溯整个线程调用堆栈。

    但是上述方法拿到的是内核线程,我们需要的信息是 NSThread,所以需要将内核线程转换为 NSThread。

    pthread 的 p 是 POSIX 的缩写,表示「可移植操作系统接口」(Portable Operating System Interface)。设计初衷是每个系统都有自己独特的线程模型,且不同系统对于线程操作的 API 都不一样。所以 POSIX 的目的就是提供抽象的 pthread 以及相关 API。这些 API 在不同的操作系统中有不同的实现,但是完成的功能一致。

    Unix 系统提供的 task_threadsthread_get_state 操作的都是内核系统,每个内核线程由 thread_t 类型的 id 唯一标识。pthread 的唯一标识是 pthread_t 类型。其中内核线程和 pthread 的转换(即 thread_t 和 pthread_t)很容易,因为 pthread 设计初衷就是「抽象内核线程」。

    memorystatus_action_neededpthread_create 方法创建线程的回调函数为 nsthreadLauncher

    static void *nsthreadLauncher(void* thread)  
    {
        NSThread *t = (NSThread*)thread;
        [nc postNotificationName: NSThreadDidStartNotification object:t userInfo: nil];
        [t _setName: [t name]];
        [t main];
        [NSThread exit];
        return NULL;
    }
    

    NSThreadDidStartNotification 其实就是字符串 @"_NSThreadDidStartNotification"。

    <NSThread: 0x...>{number = 1, name = main}  
    

    为了 NSThread 和内核线程对应起来,只能通过 name 一一对应。 pthread 的 API pthread_getname_np 也可获取内核线程名字。np 代表 not POSIX,所以不能跨平台使用。

    思路概括为:将 NSThread 的原始名字存储起来,再将名字改为某个随机数(时间戳),然后遍历内核线程 pthread 的名字,名字匹配则 NSThread 和内核线程对应了起来。找到后将线程的名字还原成原本的名字。对于主线程,由于不能使用 pthread_getname_np,所以在当前代码的 load 方法中获取到 thread_t,然后匹配名字。

    static mach_port_t main_thread_id;  
    + (void)load {
        main_thread_id = mach_thread_self();
    }
    

    二、 App 启动时间监控

    1. App 启动时间的监控

    应用启动时间是影响用户体验的重要因素之一,所以我们需要量化去衡量一个 App 的启动速度到底有多快。启动分为冷启动和热启动。

    在这里插入图片描述

    冷启动:App 尚未运行,必须加载并构建整个应用。完成应用的初始化。冷启动存在较大优化空间。冷启动时间从 application: didFinishLaunchingWithOptions: 方法开始计算,App 一般在这里进行各种 SDK 和 App 的基础初始化工作。

    热启动:应用已经在后台运行(常见场景:比如用户使用 App 过程中点击 Home 键,再打开 App),由于某些事件将应用唤醒到前台,App 会在 applicationWillEnterForeground: 方法接受应用进入前台的事件

    思路比较简单。如下:

    • 在监控类的 load 方法中先拿到当前的时间值
    • 监听 App 启动完成后的通知 UIApplicationDidFinishLaunchingNotification
    • 收到通知后拿到当前的时间
    • 步骤1和3的时间差就是 App 启动时间。

    mach_absolute_time 是一个 CPU/总线依赖函数,返回一个 CPU 时钟周期数。系统休眠时不会增加。是一个纳秒级别的数字。获取前后2个纳秒后需要转换到秒。需要基于系统时间的基准,通过 mach_timebase_info 获得。

    mach_timebase_info_data_t g_cmmStartupMonitorTimebaseInfoData = 0;
    mach_timebase_info(&g_cmmStartupMonitorTimebaseInfoData);
    uint64_t timelapse = mach_absolute_time() - g_cmmLoadTime;
    double timeSpan = (timelapse * g_cmmStartupMonitorTimebaseInfoData.numer) / (g_cmmStartupMonitorTimebaseInfoData.denom * 1e9);
    

    2. 线上监控启动时间就好,但是在开发阶段需要对启动时间做优化。

    要优化启动时间,就先得知道在启动阶段到底做了什么事情,针对现状作出方案。

    pre-main 阶段定义为 App 开始启动到系统调用 main 函数这个阶段;main 阶段定义为 main 函数入口到主 UI 框架的 viewDidAppear。

    App 启动过程:

    • 解析 Info.plist:加载相关信息例如闪屏;沙盒建立、权限检查;
    • Mach-O 加载:如果是胖二进制文件,寻找合适当前 CPU 架构的部分;加载所有依赖的 Mach-O 文件(递归调用 Mach-O 加载的方法);定义内部、外部指针引用,例如字符串、函数等;加载分类中的方法;c++ 静态对象加载、调用 Objc 的 +load() 函数;执行声明为 _attribute((constructor)) 的 c 函数;
    • 程序执行:调用 main();调用 UIApplicationMain();调用 applicationWillFinishLaunching();

    Pre-Main 阶段

    在这里插入图片描述

    Main 阶段

    在这里插入图片描述

    2.1 加载 Dylib

    每个动态库的加载,dyld 需要:

    • 分析所依赖的动态库
    • 找到动态库的 Mach-O 文件
    • 打开文件
    • 验证文件
    • 在系统核心注册文件签名
    • 对动态库的每一个 segment 调用 mmap()

    优化:

    • 减少非系统库的依赖
    • 使用静态库而不是动态库
    • 合并非系统动态库为一个动态库

    2.2 Rebase && Binding

    优化:

    • 减少 Objc 类数量,减少 selector 数量,把未使用的类和函数都可以删掉
    • 减少 c++ 虚函数数量
    • 转而使用 Swift struct(本质就是减少符号的数量)

    2.3 Initializers

    优化:

    • 使用 +initialize 代替 +load
    • 不要使用过 attribute*((constructor)) 将方法显示标记为初始化器,而是让初始化方法调用时才执行。比如使用 dispatch_one、pthread_once() 或 std::once()。也就是第一次使用时才初始化,推迟了一部分工作耗时也尽量不要使用 c++ 的静态对象

    2.4 pre-main 阶段影响因素

    • 动态库加载越多,启动越慢。
    • ObjC 类越多,函数越多,启动越慢。
    • 可执行文件越大启动越慢。
    • C 的 constructor 函数越多,启动越慢。
    • C++ 静态对象越多,启动越慢。
    • ObjC 的 +load 越多,启动越慢。

    优化手段:

    • 减少依赖不必要的库,不管是动态库还是静态库;如果可以的话,把动态库改造成静态库;如果必须依赖动态库,则把多个非系统的动态库合并成一个动态库
    • 检查下 framework应当设为optional和required,如果该framework在当前App支持的所有iOS系统版本都存在,那么就设为required,否则就设为optional,因为optional会有些额外的检查
    • 合并或者删减一些OC类和函数。关于清理项目中没用到的类,使用工具AppCode代码检查功能,查到当前项目中没有用到的类(也可以用根据linkmap文件来分析,但是准确度不算很高)有一个叫做FUI的开源项目能很好的分析出不再使用的类,准确率非常高,唯一的问题是它处理不了动态库和静态库里提供的类,也处理不了C++的类模板
    • 删减一些无用的静态变量
    • 删减没有被调用到或者已经废弃的方法
    • 将不必须在 +load 方法中做的事情延迟到 +initialize中,尽量不要用 C++ 虚函数(创建虚函数表有开销)
    • 类和方法名不要太长:iOS每个类和方法名都在 __cstring 段里都存了相应的字符串值,所以类和方法名的长短也是对可执行文件大小是有影响的,还是 Object-c 的动态特性,因为需要通过类/方法名反射找到这个类/方法进行调用,Object-c 对象模型会把类/方法名字符串都保存下来;
    • 用 dispatch_once() 代替所有的 attribute((constructor)) 函数、C++ 静态对象初始化、ObjC 的 +load 函数;
    • 在设计师可接受的范围内压缩图片的大小,会有意外收获。
      压缩图片为什么能加快启动速度呢?因为启动的时候大大小小的图片加载个十来二十个是很正常的,图片小了,IO操作量就小了,启动当然就会快了,比较靠谱的压缩算法是 TinyPNG。

    2.5 main 阶段优化

    • 减少启动初始化的流程。能懒加载就懒加载,能放后台初始化就放后台初始化,能延迟初始化的就延迟初始化,不要卡主线程的启动时间,已经下线的业务代码直接删除
    • 优化代码逻辑。去除一些非必要的逻辑和代码,减小每个流程所消耗的时间
    • 启动阶段使用多线程来进行初始化,把 CPU 性能发挥最大
    • 使用纯代码而不是 xib 或者 storyboard 来描述 UI,尤其是主 UI 框架,比如 TabBarController。因为 xib 和 storyboard 还是需要解析成代码来渲染页面,多了一步。
    展开全文
  • 开源APM监控Pinpoint的快速部署和使用

    千次阅读 2018-12-20 15:21:36
    Pinpoint是用于大规模分布式系统的APM工具。它是在Dapper(一个由Google构建的分布式系统跟踪基础架构)... Pinpoint作为一款非常优秀的开源APM监控平台,和其他开源系统一样,最繁琐的应该是部署,但是如果你能通...

           Pinpoint是用于大规模分布式系统的APM工具。它是在Dapper(一个由Google构建的分布式系统跟踪基础架构)之后构建的,为开发人员提供有关复杂分布式系统行为的更多信息。

    开源地址:https://github.com/naver/pinpoint

           Pinpoint作为一款非常优秀的开源APM监控平台,和其他开源系统一样,最繁琐的应该是部署,但是如果你能通过Docker的方式进行部署,我们就可以感受到一键部署的便捷:

    Docker镜像地址:https://hub.docker.com/u/pinpointdocker

    Docker-compose地址:https://github.com/naver/pinpoint-docker

    一、部署前准备

    在Centos7系统上安装Docker和docker-compose

    yum update -y
    yum install docker epel-release python-pip -y
    pip install --upgrade pip
    pip install docker-compose

    对于docker-compose也可以安装指定版本(比如最新版的,因为不同版本支持不同格式的docker-compose文件)

    yum update -y nss curl libcurl
    sudo curl -L https://github.com/docker/compose/releases/download/1.23.2/docker-compose-Linux-x86_64 -o /usr/local/bin/docker-compose
    chmod +x /usr/local/bin/docker-compose

    为了加速docker镜像pull速度,可以修改daemon.json

    # cat /etc/docker/daemon.json
    {"registry-mirrors": ["http://579fe187.m.daocloud.io","https://pee6w651.mirror.aliyuncs.com"]}

    启动docker

    systemctl enable docker
    systemctl start docker

    二、安装Pinpoint

    按照官网的docker部署方式:https://github.com/naver/pinpoint-docker (部署前把宿主机防火墙都关了)

    git clone https://github.com/naver/pinpoint-docker.git
    cd Pinpoint-Docker
    docker-compose pull && docker-compose up -d

    直接这样部署可能会有问题,比如我们只在一台宿主机上部署,我们可以用git命令下载,或是用curl命令先下载zip再解压:

    sudo curl -L https://github.com/naver/pinpoint-docker/archive/master.zip -o /opt/pinpoint-docker.zip
    cd /opt
    upzip pinpoint-docker.zip -d .
    cd /opt/pinpoint-docker-master

    编辑docker-compose.yml,将多个节点的zookeeper改成一个节点(注释掉不需要的):

    #zookeepers
      zoo1:
        image: zookeeper:3.4
        restart: always
        #hostname: zoo1
        hostname: 172.17.2.84
        environment:
          ZOO_MY_ID: 1
          #ZOO_SERVERS: server.1=0.0.0.0:2888:3888 server.2=zoo2:2888:3888 server.3=zoo3:2888:3888
          ZOO_SERVERS: server.1=0.0.0.0:2888:3888
        networks:
          - pinpoint
    
      #zoo2:
      #  image: zookeeper:3.4
      #  restart: always
      #  hostname: zoo2
      #  environment:
      #    ZOO_MY_ID: 2
      #    ZOO_SERVERS: server.1=zoo1:2888:3888 server.2=0.0.0.0:2888:3888 server.3=zoo3:2888:3888
      #  networks:
      #    - pinpoint
    
      #zoo3:
      #  image: zookeeper:3.4
      #  restart: always
      #  hostname: zoo3
      #  environment:
      #    ZOO_MY_ID: 3
      #    ZOO_SERVERS: server.1=zoo1:2888:3888 server.2=zoo2:2888:3888 server.3=0.0.0.0:2888:3888
      #  networks:
      #    - pinpoint

    如还有问题,请修改相对路径为绝对路径

    ...
     volumes:
          - /home/pinpoint/hbase
          - /home/pinpoint/zookeeper
    ...

     基本我在根目录下,运行docker-compose up -d 就能完成docker集群的部署(在后台进行),如果是想看清部署的整个过程,直接用命令:

    docker-compose up

    启动完后容器:

    用Rancher查看能比较直观:

     安装完后,就可以连接http://172.17.2.84:8079查看,除了一个quickapp应用,什么也没有:

    三、部署监控代理

    为了监控我们的应用(tomcat、Java、weblogic等),就需要部署监控代理,这个非常简单,首先是去官网下载同版本的agent包:https://github.com/naver/pinpoint/releases/download/1.8.0/pinpoint-agent-1.8.0.tar.gz

    将agent包解压到应用(以tomcat为例)目录下:

    tar zxvf pinpoint-agent-1.8.0.tar.gz -C pinpoint-agent

    修改配置文件pinpoint.config,将collector的ip配置为监控收集服务pinpoint-collector的IP:

    然后修改tomcat的启动文件catalina.sh,添加javaagent配置参数(这一点和其他商用APM监控工具一样):

    JAVA_OPTS="$JAVA_OPTS -javaagent:/usr/apache-tomcat-7.0.54/pinpoint-agent/pinpoint-bootstrap-1.8.0.jar"
    JAVA_OPTS="$JAVA_OPTS -Dpinpoint.agentId=APM-104"
    JAVA_OPTS="$JAVA_OPTS -Dpinpoint.applicationName=tomcat7-test"

    除了javaagent参数,还有agentId参数(应用的唯一标识,不允许和其他应用重名),和applicationName(应用名)。

    配完后,就可以重启tomcat了,那么在界面上就能看到新追加的应用了:

     对于微服务的jar包也能进行监控:

    java -javaagent:/mypath/pinpoint-agent/pinpoint-bootstrap-1.8.0.jar -Dpinpoint.agentId=APM-104 -Dpinpoint.applicationName=tomcat7-test -jar myapp.jar

    四、使用手册

    1. 查看调用关系

    1.1 访问地址
    http://yoururl
    1.2 选择应用

    默认两层展示

    调整层级深度:

    示例为前端调用4层追溯,后端调用4层追溯(4层为最深层级)

    结果展示:

    在图片内按鼠标滚轮调整图片大小。

    连线上数字为调用次数

    选择更多时间范围(默认最新5分钟)

    2. 查看调用链

    鼠标按住右键(其实不分左右键),选中图中区域,松开鼠标键,则展示选中时间段调用层级

    展示结果:

    默认按耗时排序

    选中某一调用,展示详细调用链及耗时

    选中timelinetab可查看耗时情况:

    3. 查看错误信息

    3.1 选择错误应用

    机器应用抛出错误,机器应用会标红

    3.2 查看详细信息
    选中应用,去除成功多选按钮选中对勾,按住鼠标右键,选中红点范围,松开鼠标右键,即可查看详细错误信息:

    结果为:

    选中某次错误请求,可在详细列表内找到详细错误信息

    4. 查看应用情况

    选中某一应用
    单击inspector

    选中某一机器id,时间段,可展示jvm详细信息

    其中内容包含:Jvm内存使用情况,Jvm永久带使用占用空间,Cpu使用情况,每秒处理的消息数(S标识操作系统,U标识此应用),Jvm线程情况,单请求平均响应时间等。

    展开全文
  • 微服务监控需求 随着微服务架构的流行,服务按照不同的维度进行拆分,一次请求往往需要涉及到多个服务。这些服务可能不同编程语言开发,不同团队开发,可能部署很多副本。因此,就需要一些可以帮助理解系统行为、...

    微服务监控需求


    随着微服务架构的流行, 服务按照不同的维度进行拆分 ,一次请求往往需要涉及到多个服务。这些服务可能不同编程语言开发,不同团队开发,可能部署很多副本。因此,就需要一些可以帮助理解系统行为、用于分析性能问题的工具,以便发生故障的时候,能够快速定位和解决问题。“APM系统” 就在这样的问题背景下产生了。
    APM系统 从整体维度到局部维度展示各项指标 ,将跨应用的所有调用链性能信息集中展现,可方便度量整体和局部性能,并且方便找到故障产生的源头,生产上可极大缩短故障排除时间。

     

    APM监控系统是什么


    APM(ApplicationPerformance Management) 是一种应用性能监控工具,通过汇聚业务系统各处理环节的实时数据,分析业务系统各事务处理的交易路径和处理时间,实现对应用的全链路性能监测。
    相比接触的Prometheus、Zabbix这类监控系统,APM系统主要监控对应用程序内部,例如:
    • 请求链路追踪:通过分析服务调用关系,绘制运行时拓扑信息,可视化展示
    • 调用情况衡量:各个调用环节的性能分析,例如吞吐量、响应时间、错误次数
    • 运行情况反馈:告警,通过调用链结合业务日志快速定位错误信息

     

    APM监控系统选择依据


    APM类监控系统有:Skywalking、Pinpoint、Zipkin

    关于选型,可以从以下方面考虑:
    探针的性能消耗
    APM组件服务的影响应该做到足够小,数据分析要快,性能占用小。
    代码的侵入性
    即也作为业务组件,应当尽可能少入侵或者无入侵其他业务系统,对于使用方透明,减少开发人员的负担。
    监控维度
    分析的维度尽可能多。
    可扩展性
    一个优秀的调用跟踪系统必须支持分布式部署,具备良好的可扩展性。能够支持的组件越多当然越好

    Skywalking介绍


    Skywalking 是一个分布式应用程序性能监控系统,针对微服务体系结构而设计。

    功能:

    • 多种监控手段。可以通过语言探针和 service mesh 获得监控是数据。
    • 多个语言自动探针。包括 Java,.NET Core 和 Node.JS。
    • 轻量高效。无需大数据平台,和大量的服务器资源。
    • 模块化。UI、存储、集群管理都有多种机制可选。
    • 支持告警。
    • 优秀的可视化解决方案

    Skywalking架构 


     

    Skywalking部署


    1、部署ES数据库

    docker run --name elasticsearch -p 9200:9200 -e "discovery.type=single-node" -d elasticsearch:7.7.0

    2、部署Skywalking OAP 

    软件包下载地址:https://archive.apache.org/dist/skywalking/8.3.0/
    yum install java-11-openjdk –y
    tar zxvf apache-skywalking-apm-es7-8.3.0.tar.gz
    cd apache-skywalking-apm-bin-es7/
    [root@monitor apache-skywalking-apm-bin-es7]# ls
    agent  bin  config  LICENSE  licenses  NOTICE  oap-libs  README.txt  tools  webapp
    
    #使用哪块配置
    storage:
      selector: ${SW_STORAGE:elasticsearch7}
    
    #指定使用具体IP地址
      elasticsearch7:
        nameSpace: ${SW_NAMESPACE:""}
        clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:127.0.0.1:9200}
    
    #启动OAP和UI
    [root@monitor bin]# ./startup.sh 
    SkyWalking OAP started successfully!
    SkyWalking Web Application started successfully!
    
    
    [root@monitor apache-skywalking-apm-bin-es7]# cd logs/
    [root@monitor logs]# ls
    oap.log  skywalking-oap-server.log  webapp-console.log  webapp.log
    [root@monitor logs]# tail -f skywalking-oap-server.log 
    
    
    [root@monitor logs]# netstat -tpln | grep -w 8080
    tcp6       0      0 :::8080                 :::*                    LISTEN      14641/java

    微服务接入监控


     内置Agent包路径:apache-skywalking-apm-bin-es7/agent/

    启动Java程序以探针方式集成Agent:
    java -jar -javaagent:/skywalking/skywalking-agent.jar=agent.service_name=<项目名称
    >,agent.instance_name=<实例名称>,collector.backend_service=<Skywalking服务器>:11800 xxx.jar
    [root@master product-service]# cd product-service-biz/
    [root@master product-service-biz]# ls
    Dockerfile  pom.xml  skywalking  src
    [root@master product-service-biz]# cat Dockerfile 
    FROM lizhenliang/java:8-jdk-alpine
    LABEL maintainer www.ctnrs.com
    COPY ./target/product-service-biz.jar ./
    COPY skywalking /skywalking
    EXPOSE 8010
    CMD java -jar -javaagent:/skywalking/skywalking-agent.jar=agent.service_name=ms-product,agent.instance_name=$(echo $HOSTNAME | awk -F- '{print $1"-"$NF}'),collector.backend_service=192.168.31.90:11800 /product-service-biz.jar
    
    
    [root@master order-service-biz]# kubectl get pod -n ms
    NAME                       READY   STATUS    RESTARTS   AGE
    eureka-0                   1/1     Running   1          27d
    eureka-1                   1/1     Running   1          27d
    eureka-2                   1/1     Running   1          27d
    gateway-fcdff7b65-2jn7f    1/1     Running   1          36d
    order-5775448c6-rz74g      1/1     Running   1          36d
    portal-586dbdfc8-hm85c     1/1     Running   1          36d
    product-69b4846b89-tbzsh   1/1     Running   0          15m
    stock-67d849958d-5jk5v     1/1     Running   0          3m41s
    [root@master order-service-biz]# HOSTNAME=product-69b4846b89-tbzsh
    [root@master order-service-biz]# echo $HOSTNAME | awk -F- '{print $1"-"$NF}'
    product-tbzsh
    
    
    
    [root@master product-service-biz]# docker build -t reg.harbor.com/microservice/product:skywalking .
    Sending build context to Docker daemon   96.2MB
    Step 1/6 : FROM java:8-jdk-alpine
     ---> 3fd9dd82815c
    Step 2/6 : RUN  apk add -U tzdata &&      ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
     ---> Using cache
     ---> 3d79cdf17999
    Step 3/6 : COPY ./target/product-service-biz.jar ./
     ---> Using cache
     ---> af45498b45de
    Step 4/6 : COPY skywalking /skywalking
     ---> 972d1d84872b
    Step 5/6 : EXPOSE 8010
     ---> Running in 35409311758b
    Removing intermediate container 35409311758b
     ---> 1ce48f156ad9
    Step 6/6 : CMD java -jar -javaagent:/skywalking/skywalking-agent.jar=agent.service_name=ms-product,agent.instance_name=$(echo $HOSTNAME | awk -F- '{print $1"-"$NF}'),collector.backend_service=192.168.0.13:11800 /product-service-biz.jar
     ---> Running in b43839309d41
    Removing intermediate container b43839309d41
     ---> 67c0ec036979
    Successfully built 67c0ec036979
    Successfully tagged reg.harbor.com/microservice/product:skywalking
    [root@master product-service-biz]# docker push reg.harbor.com/microservice/product:skywalking
    The push refers to repository [reg.harbor.com/microservice/product]
    b594484b0bd9: Pushed 
    a7eb54fcd329: Layer already exists 
    1a6781d58798: Layer already exists 
    a1e7033f082e: Layer already exists 
    78075328e0da: Layer already exists 
    9f8566ee5135: Layer already exists 
    skywalking: digest: sha256:a7205a5e0b823b65006a711af155206d615371a2101ed1b36c4d264c8335fad4 size: 1582

    展开全文
  • 带你打造一套 APM 监控系统(四)

    千次阅读 2020-07-14 11:07:34
    七、 Crash 监控 1. 异常相关知识回顾 1.1 Mach 层对异常的处理 Mach 在消息传递基础上实现了一套独特的异常处理方法。Mach 异常处理在设计时考虑到: 带有一致的语义的单一异常处理设施:Mach 只提供一个异常处理...

    声明:尊重原创,原文地址:《带你打造一套 APM 监控系统》。本文为根据原创文章整理所得,感谢浏览。

    七、 Crash 监控

    1. 异常相关知识回顾

    1.1 Mach 层对异常的处理

    Mach 在消息传递基础上实现了一套独特的异常处理方法。Mach 异常处理在设计时考虑到:

    • 带有一致的语义的单一异常处理设施:Mach 只提供一个异常处理机制用于处理所有类型的异常(包括用户定义的异常、平台无关的异常以及平台特定的异常)。根据异常类型进行分组,具体的平台可以定义具体的子类型。
    • 清晰和简洁:异常处理的接口依赖于 Mach 已有的具有良好定义的消息和端口架构,因此非常优雅(不会影响效率)。这就允许调试器和外部处理程序的拓展-甚至在理论上还支持拓展基于网络的异常处理。

    在 Mach 中,异常是通过内核中的基础设施-消息传递机制处理的。一个异常并不比一条消息复杂多少,异常由出错的线程或者任务(通过 msg_send()) 抛出,然后由一个处理程序通过 msg_recv())捕捉。处理程序可以处理异常,也可以清楚异常(将异常标记为已完成并继续),还可以决定终止线程。

    Mach 的异常处理模型和其他的异常处理模型不同,其他模型的异常处理程序运行在出错的线程上下文中,而 Mach 的异常处理程序在不同的上下文中运行异常处理程序,出错的线程向预先指定好的异常端口发送消息,然后等待应答。每一个任务都可以注册一个异常处理端口,这个异常处理端口会对该任务中的所有线程生效。此外,每个线程都可以通过 :thread_set_exception_ports(<#thread_act_t thread#>, <#exception_mask_t exception_mask#>, <#mach_port_t new_port#>, <#exception_behavior_t behavior#>, <#thread_state_flavor_t new_flavor#>) 注册自己的异常处理端口。通常情况下,任务和线程的异常端口都是 NULL,也就是异常不会被处理,而一旦创建异常端口,这些端口就像系统中的其他端口一样,可以转交给其他任务或者其他主机。(有了端口,就可以使用 UDP 协议,通过网络能力让其他的主机上应用程序处理异常)。

    发生异常时,首先尝试将异常抛给线程的异常端口,然后尝试抛给任务的异常端口,最后再抛给主机的异常端口(即主机注册的默认端口)。如果没有一个端口返回 KERN_SUCCESS,那么整个任务将被终止。也就是 Mach 不提供异常处理逻辑,只提供传递异常通知的框架。

    异常首先是由处理器陷阱引发的。为了处理陷阱,每一个现代的内核都会安插陷阱处理程序。这些底层函数是由内核的汇编部分安插的。

    1.2 BSD 层对异常的处理

    BSD 层是用户态主要使用的 XUN 接口,这一层展示了一个符合 POSIX 标准的接口。开发者可以使用 UNIX 系统的一切功能,但不需要了解 Mach 层的细节实现。

    Mach 已经通过异常机制提供了底层的陷进处理,而 BSD 则在异常机制之上构建了信号处理机制。硬件产生的信号被 Mach 层捕捉,然后转换为对应的 UNIX 信号,为了维护一个统一的机制,操作系统和用户产生的信号首先被转换为 Mach 异常,然后再转换为信号。

    Mach 异常都在 host 层被 ux_exception 转换为相应的 unix 信号,并通过 threadsignal 将信号投递到出错的线程。

    在这里插入图片描述

    2. Crash 收集方式

    iOS 系统自带的 Apples`s Crash Reporter 在设置中记录 Crash 日志,我们先观察下 Crash 日志

    Incident Identifier: 7FA6736D-09E8-47A1-95EC-76C4522BDE1A
    CrashReporter Key:   4e2d36419259f14413c3229e8b7235bcc74847f3
    Hardware Model:      iPhone7,1
    Process:         CMMonitorExample [3608]
    Path:            /var/containers/Bundle/Application/9518A4F4-59B7-44E9-BDDA-9FBEE8CA18E5/CMMonitorExample.app/CMMonitorExample
    Identifier:      com.Wacai.CMMonitorExample
    Version:         1.0 (1)
    Code Type:       ARM-64
    Parent Process:  ? [1]
    
    Date/Time:       2017-01-03 11:43:03.000 +0800
    OS Version:      iOS 10.2 (14C92)
    Report Version:  104
    
    Exception Type:  EXC_CRASH (SIGABRT)
    Exception Codes: 0x00000000 at 0x0000000000000000
    Crashed Thread:  0
    
    Application Specific Information:
    *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[__NSSingleObjectArrayI objectForKey:]: unrecognized selector sent to instance 0x174015060'
    
    Thread 0 Crashed:
    0   CoreFoundation                  0x0000000188f291b8 0x188df9000 + 1245624 (<redacted> + 124)
    1   libobjc.A.dylib                 0x000000018796055c 0x187958000 + 34140 (objc_exception_throw + 56)
    2   CoreFoundation                  0x0000000188f30268 0x188df9000 + 1274472 (<redacted> + 140)
    3   CoreFoundation                  0x0000000188f2d270 0x188df9000 + 1262192 (<redacted> + 916)
    4   CoreFoundation                  0x0000000188e2680c 0x188df9000 + 186380 (_CF_forwarding_prep_0 + 92)
    5   CMMonitorExample                0x000000010004c618 0x100044000 + 34328 (-[MakeCrashHandler throwUncaughtNSException] + 80)
    

    会发现,Crash 日志中 Exception Type 项由2部分组成:Mach 异常 + Unix 信号。

    所以 Exception Type: EXC_CRASH (SIGABRT) 表示:Mach 层发生了 EXC_CRASH 异常,在 host 层被转换为 SIGABRT 信号投递到出错的线程。

    问题: 捕获 Mach 层异常、注册 Unix 信号处理都可以捕获 Crash,这两种方式如何选择?

    答: 优选 Mach 层异常拦截。根据上面 1.2 中的描述我们知道 Mach 层异常处理时机更早些,假如 Mach 层异常处理程序让进程退出,这样 Unix 信号永远不会发生了。

    业界关于崩溃日志的收集开源项目很多,著名的有: KSCrash、plcrashreporter,提供一条龙服务的 Bugly、友盟等。我们一般使用开源项目在此基础上开发成符合公司内部需求的 bug 收集工具。一番对比后选择 KSCrash。为什么选择 KSCrash 不在本文重点。

    KSCrash 功能齐全,可以捕获如下类型的 Crash

    • Mach kernel exceptions
    • Fatal signals
    • C++ exceptions
    • Objective-C exceptions
    • Main thread deadlock (experimental)
    • Custom crashes (e.g. from scripting languages)

    所以分析 iOS 端的 Crash 收集方案也就是分析 KSCrash 的 Crash 监控实现原理。

    2.1. Mach 层异常处理

    大体思路是:先创建一个异常处理端口,为该端口申请权限,再设置异常端口、新建一个内核线程,在该线程内循环等待异常。但是为了防止自己注册的 Mach 层异常处理抢占了其他 SDK、或者业务线开发者设置的逻辑,我们需要在最开始保存其他的异常处理端口,等逻辑执行完后将异常处理交给其他的端口内的逻辑处理。收集到 Crash 信息后组装数据,写入 json 文件。

    流程图如下:

    在这里插入图片描述

    对于 Mach 异常捕获,可以注册一个异常端口,该端口负责对当前任务的所有线程进行监听。

    下面来看看关键代码:

    注册 Mach 层异常监听代码

    static bool installExceptionHandler()
    {
        KSLOG_DEBUG("Installing mach exception handler.");
    
        bool attributes_created = false;
        pthread_attr_t attr;
    
        kern_return_t kr;
        int error;
        // 拿到当前进程
        const task_t thisTask = mach_task_self();
        exception_mask_t mask = EXC_MASK_BAD_ACCESS |
        EXC_MASK_BAD_INSTRUCTION |
        EXC_MASK_ARITHMETIC |
        EXC_MASK_SOFTWARE |
        EXC_MASK_BREAKPOINT;
    
        KSLOG_DEBUG("Backing up original exception ports.");
        // 获取该 Task 上的注册好的异常端口
        kr = task_get_exception_ports(thisTask,
                                      mask,
                                      g_previousExceptionPorts.masks,
                                      &g_previousExceptionPorts.count,
                                      g_previousExceptionPorts.ports,
                                      g_previousExceptionPorts.behaviors,
                                      g_previousExceptionPorts.flavors);
        // 获取失败走 failed 逻辑
        if(kr != KERN_SUCCESS)
        {
            KSLOG_ERROR("task_get_exception_ports: %s", mach_error_string(kr));
            goto failed;
        }
        // KSCrash 的异常为空则走执行逻辑
        if(g_exceptionPort == MACH_PORT_NULL)
        {
            KSLOG_DEBUG("Allocating new port with receive rights.");
            // 申请异常处理端口
            kr = mach_port_allocate(thisTask,
                                    MACH_PORT_RIGHT_RECEIVE,
                                    &g_exceptionPort);
            if(kr != KERN_SUCCESS)
            {
                KSLOG_ERROR("mach_port_allocate: %s", mach_error_string(kr));
                goto failed;
            }
    
            KSLOG_DEBUG("Adding send rights to port.");
            // 为异常处理端口申请权限:MACH_MSG_TYPE_MAKE_SEND
            kr = mach_port_insert_right(thisTask,
                                        g_exceptionPort,
                                        g_exceptionPort,
                                        MACH_MSG_TYPE_MAKE_SEND);
            if(kr != KERN_SUCCESS)
            {
                KSLOG_ERROR("mach_port_insert_right: %s", mach_error_string(kr));
                goto failed;
            }
        }
    
        KSLOG_DEBUG("Installing port as exception handler.");
        // 为该 Task 设置异常处理端口
        kr = task_set_exception_ports(thisTask,
                                      mask,
                                      g_exceptionPort,
                                      EXCEPTION_DEFAULT,
                                      THREAD_STATE_NONE);
        if(kr != KERN_SUCCESS)
        {
            KSLOG_ERROR("task_set_exception_ports: %s", mach_error_string(kr));
            goto failed;
        }
    
        KSLOG_DEBUG("Creating secondary exception thread (suspended).");
        pthread_attr_init(&attr);
        attributes_created = true;
        pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
        // 设置监控线程
        error = pthread_create(&g_secondaryPThread,
                               &attr,
                               &handleExceptions,
                               kThreadSecondary);
        if(error != 0)
        {
            KSLOG_ERROR("pthread_create_suspended_np: %s", strerror(error));
            goto failed;
        }
        // 转换为 Mach 内核线程
        g_secondaryMachThread = pthread_mach_thread_np(g_secondaryPThread);
        ksmc_addReservedThread(g_secondaryMachThread);
    
        KSLOG_DEBUG("Creating primary exception thread.");
        error = pthread_create(&g_primaryPThread,
                               &attr,
                               &handleExceptions,
                               kThreadPrimary);
        if(error != 0)
        {
            KSLOG_ERROR("pthread_create: %s", strerror(error));
            goto failed;
        }
        pthread_attr_destroy(&attr);
        g_primaryMachThread = pthread_mach_thread_np(g_primaryPThread);
        ksmc_addReservedThread(g_primaryMachThread);
        
        KSLOG_DEBUG("Mach exception handler installed.");
        return true;
    
    
    failed:
        KSLOG_DEBUG("Failed to install mach exception handler.");
        if(attributes_created)
        {
            pthread_attr_destroy(&attr);
        }
        // 还原之前的异常注册端口,将控制权还原
        uninstallExceptionHandler();
        return false;
    }
    

    处理异常的逻辑、组装崩溃信息

    /** Our exception handler thread routine.
     * Wait for an exception message, uninstall our exception port, record the
     * exception information, and write a report.
     */
    static void* handleExceptions(void* const userData)
    {
        MachExceptionMessage exceptionMessage = {{0}};
        MachReplyMessage replyMessage = {{0}};
        char* eventID = g_primaryEventID;
    
        const char* threadName = (const char*) userData;
        pthread_setname_np(threadName);
        if(threadName == kThreadSecondary)
        {
            KSLOG_DEBUG("This is the secondary thread. Suspending.");
            thread_suspend((thread_t)ksthread_self());
            eventID = g_secondaryEventID;
        }
        // 循环读取注册好的异常端口信息
        for(;;)
        {
            KSLOG_DEBUG("Waiting for mach exception");
    
            // Wait for a message.
            kern_return_t kr = mach_msg(&exceptionMessage.header,
                                        MACH_RCV_MSG,
                                        0,
                                        sizeof(exceptionMessage),
                                        g_exceptionPort,
                                        MACH_MSG_TIMEOUT_NONE,
                                        MACH_PORT_NULL);
            // 获取到信息后则代表发生了 Mach 层异常,跳出 for 循环,组装数据
            if(kr == KERN_SUCCESS)
            {
                break;
            }
    
            // Loop and try again on failure.
            KSLOG_ERROR("mach_msg: %s", mach_error_string(kr));
        }
    
        KSLOG_DEBUG("Trapped mach exception code 0x%x, subcode 0x%x",
                    exceptionMessage.code[0], exceptionMessage.code[1]);
        if(g_isEnabled)
        {
            // 挂起所有线程
            ksmc_suspendEnvironment();
            g_isHandlingCrash = true;
            // 通知发生了异常
            kscm_notifyFatalExceptionCaptured(true);
    
            KSLOG_DEBUG("Exception handler is installed. Continuing exception handling.");
    
    
            // Switch to the secondary thread if necessary, or uninstall the handler
            // to avoid a death loop.
            if(ksthread_self() == g_primaryMachThread)
            {
                KSLOG_DEBUG("This is the primary exception thread. Activating secondary thread.");
    // TODO: This was put here to avoid a freeze. Does secondary thread ever fire?
                restoreExceptionPorts();
                if(thread_resume(g_secondaryMachThread) != KERN_SUCCESS)
                {
                    KSLOG_DEBUG("Could not activate secondary thread. Restoring original exception ports.");
                }
            }
            else
            {
                KSLOG_DEBUG("This is the secondary exception thread. Restoring original exception ports.");
    //            restoreExceptionPorts();
            }
    
            // Fill out crash information
            // 组装异常所需要的方案现场信息
            KSLOG_DEBUG("Fetching machine state.");
            KSMC_NEW_CONTEXT(machineContext);
            KSCrash_MonitorContext* crashContext = &g_monitorContext;
            crashContext->offendingMachineContext = machineContext;
            kssc_initCursor(&g_stackCursor, NULL, NULL);
            if(ksmc_getContextForThread(exceptionMessage.thread.name, machineContext, true))
            {
                kssc_initWithMachineContext(&g_stackCursor, 100, machineContext);
                KSLOG_TRACE("Fault address 0x%x, instruction address 0x%x", kscpu_faultAddress(machineContext), kscpu_instructionAddress(machineContext));
                if(exceptionMessage.exception == EXC_BAD_ACCESS)
                {
                    crashContext->faultAddress = kscpu_faultAddress(machineContext);
                }
                else
                {
                    crashContext->faultAddress = kscpu_instructionAddress(machineContext);
                }
            }
    
            KSLOG_DEBUG("Filling out context.");
            crashContext->crashType = KSCrashMonitorTypeMachException;
            crashContext->eventID = eventID;
            crashContext->registersAreValid = true;
            crashContext->mach.type = exceptionMessage.exception;
            crashContext->mach.code = exceptionMessage.code[0];
            crashContext->mach.subcode = exceptionMessage.code[1];
            if(crashContext->mach.code == KERN_PROTECTION_FAILURE && crashContext->isStackOverflow)
            {
                // A stack overflow should return KERN_INVALID_ADDRESS, but
                // when a stack blasts through the guard pages at the top of the stack,
                // it generates KERN_PROTECTION_FAILURE. Correct for this.
                crashContext->mach.code = KERN_INVALID_ADDRESS;
            }
            crashContext->signal.signum = signalForMachException(crashContext->mach.type, crashContext->mach.code);
            crashContext->stackCursor = &g_stackCursor;
    
            kscm_handleException(crashContext);
    
            KSLOG_DEBUG("Crash handling complete. Restoring original handlers.");
            g_isHandlingCrash = false;
            ksmc_resumeEnvironment();
        }
    
        KSLOG_DEBUG("Replying to mach exception message.");
        // Send a reply saying "I didn't handle this exception".
        replyMessage.header = exceptionMessage.header;
        replyMessage.NDR = exceptionMessage.NDR;
        replyMessage.returnCode = KERN_FAILURE;
    
        mach_msg(&replyMessage.header,
                 MACH_SEND_MSG,
                 sizeof(replyMessage),
                 0,
                 MACH_PORT_NULL,
                 MACH_MSG_TIMEOUT_NONE,
                 MACH_PORT_NULL);
    
        return NULL;
    }
    

    还原异常处理端口,转移控制权

    /** Restore the original mach exception ports.
     */
    static void restoreExceptionPorts(void)
    {
        KSLOG_DEBUG("Restoring original exception ports.");
        if(g_previousExceptionPorts.count == 0)
        {
            KSLOG_DEBUG("Original exception ports were already restored.");
            return;
        }
    
        const task_t thisTask = mach_task_self();
        kern_return_t kr;
    
        // Reinstall old exception ports.
        // for 循环去除保存好的在 KSCrash 之前注册好的异常端口,将每个端口注册回去
        for(mach_msg_type_number_t i = 0; i < g_previousExceptionPorts.count; i++)
        {
            KSLOG_TRACE("Restoring port index %d", i);
            kr = task_set_exception_ports(thisTask,
                                          g_previousExceptionPorts.masks[i],
                                          g_previousExceptionPorts.ports[i],
                                          g_previousExceptionPorts.behaviors[i],
                                          g_previousExceptionPorts.flavors[i]);
            if(kr != KERN_SUCCESS)
            {
                KSLOG_ERROR("task_set_exception_ports: %s",
                            mach_error_string(kr));
            }
        }
        KSLOG_DEBUG("Exception ports restored.");
        g_previousExceptionPorts.count = 0;
    }
    

    2.2. Signal 异常处理

    对于 Mach 异常,操作系统会将其转换为对应的 Unix 信号,所以开发者可以通过注册 signanHandler 的方式来处理。

    KSCrash 在这里的处理逻辑如下图:

    在这里插入图片描述

    看一下关键代码:

    设置信号处理函数

    static bool installSignalHandler()
    {
        KSLOG_DEBUG("Installing signal handler.");
    
    #if KSCRASH_HAS_SIGNAL_STACK
        // 在堆上分配一块内存,
        if(g_signalStack.ss_size == 0)
        {
            KSLOG_DEBUG("Allocating signal stack area.");
            g_signalStack.ss_size = SIGSTKSZ;
            g_signalStack.ss_sp = malloc(g_signalStack.ss_size);
        }
        // 信号处理函数的栈挪到堆中,而不和进程共用一块栈区
        // sigaltstack() 函数,该函数的第 1 个参数 sigstack 是一个 stack_t 结构的指针,该结构存储了一个“可替换信号栈” 的位置及属性信息。第 2 个参数 old_sigstack 也是一个 stack_t 类型指针,它用来返回上一次建立的“可替换信号栈”的信息(如果有的话)
        KSLOG_DEBUG("Setting signal stack area.");
        // sigaltstack 第一个参数为创建的新的可替换信号栈,第二个参数可以设置为NULL,如果不为NULL的话,将会将旧的可替换信号栈的信息保存在里面。函数成功返回0,失败返回-1.
        if(sigaltstack(&g_signalStack, NULL) != 0)
        {
            KSLOG_ERROR("signalstack: %s", strerror(errno));
            goto failed;
        }
    #endif
    
        const int* fatalSignals = kssignal_fatalSignals();
        int fatalSignalsCount = kssignal_numFatalSignals();
    
        if(g_previousSignalHandlers == NULL)
        {
            KSLOG_DEBUG("Allocating memory to store previous signal handlers.");
            g_previousSignalHandlers = malloc(sizeof(*g_previousSignalHandlers)
                                              * (unsigned)fatalSignalsCount);
        }
    
        // 设置信号处理函数 sigaction 的第二个参数,类型为 sigaction 结构体
        struct sigaction action = {{0}};
        // sa_flags 成员设立 SA_ONSTACK 标志,该标志告诉内核信号处理函数的栈帧就在“可替换信号栈”上建立。
        action.sa_flags = SA_SIGINFO | SA_ONSTACK;
    #if KSCRASH_HOST_APPLE && defined(__LP64__)
        action.sa_flags |= SA_64REGSET;
    #endif
        sigemptyset(&action.sa_mask);
        action.sa_sigaction = &handleSignal;
    
        // 遍历需要处理的信号数组
        for(int i = 0; i < fatalSignalsCount; i++)
        {
            // 将每个信号的处理函数绑定到上面声明的 action 去,另外用 g_previousSignalHandlers 保存当前信号的处理函数
            KSLOG_DEBUG("Assigning handler for signal %d", fatalSignals[i]);
            if(sigaction(fatalSignals[i], &action, &g_previousSignalHandlers[i]) != 0)
            {
                char sigNameBuff[30];
                const char* sigName = kssignal_signalName(fatalSignals[i]);
                if(sigName == NULL)
                {
                    snprintf(sigNameBuff, sizeof(sigNameBuff), "%d", fatalSignals[i]);
                    sigName = sigNameBuff;
                }
                KSLOG_ERROR("sigaction (%s): %s", sigName, strerror(errno));
                // Try to reverse the damage
                for(i--;i >= 0; i--)
                {
                    sigaction(fatalSignals[i], &g_previousSignalHandlers[i], NULL);
                }
                goto failed;
            }
        }
        KSLOG_DEBUG("Signal handlers installed.");
        return true;
    
    failed:
        KSLOG_DEBUG("Failed to install signal handlers.");
        return false;
    }
    

    信号处理时记录线程等上下文信息

    static void handleSignal(int sigNum, siginfo_t* signalInfo, void* userContext)
    {
        KSLOG_DEBUG("Trapped signal %d", sigNum);
        if(g_isEnabled)
        {
            ksmc_suspendEnvironment();
            kscm_notifyFatalExceptionCaptured(false);
            
            KSLOG_DEBUG("Filling out context.");
            KSMC_NEW_CONTEXT(machineContext);
            ksmc_getContextForSignal(userContext, machineContext);
            kssc_initWithMachineContext(&g_stackCursor, 100, machineContext);
            // 记录信号处理时的上下文信息
            KSCrash_MonitorContext* crashContext = &g_monitorContext;
            memset(crashContext, 0, sizeof(*crashContext));
            crashContext->crashType = KSCrashMonitorTypeSignal;
            crashContext->eventID = g_eventID;
            crashContext->offendingMachineContext = machineContext;
            crashContext->registersAreValid = true;
            crashContext->faultAddress = (uintptr_t)signalInfo->si_addr;
            crashContext->signal.userContext = userContext;
            crashContext->signal.signum = signalInfo->si_signo;
            crashContext->signal.sigcode = signalInfo->si_code;
            crashContext->stackCursor = &g_stackCursor;
    
            kscm_handleException(crashContext);
            ksmc_resumeEnvironment();
        }
    
        KSLOG_DEBUG("Re-raising signal for regular handlers to catch.");
        // This is technically not allowed, but it works in OSX and iOS.
        raise(sigNum);
    }
    

    KSCrash 信号处理后还原之前的信号处理权限

    static void uninstallSignalHandler(void)
    {
        KSLOG_DEBUG("Uninstalling signal handlers.");
    
        const int* fatalSignals = kssignal_fatalSignals();
        int fatalSignalsCount = kssignal_numFatalSignals();
        // 遍历需要处理信号数组,将之前的信号处理函数还原
        for(int i = 0; i < fatalSignalsCount; i++)
        {
            KSLOG_DEBUG("Restoring original handler for signal %d", fatalSignals[i]);
            sigaction(fatalSignals[i], &g_previousSignalHandlers[i], NULL);
        }
        
        KSLOG_DEBUG("Signal handlers uninstalled.");
    }
    

    说明:

    1. 先从堆上分配一块内存区域,被称为“可替换信号栈”,目的是将信号处理函数的栈干掉,用堆上的内存区域代替,而不和进程共用一块栈区。

      为什么这么做?一个进程可能有 n 个线程,每个线程都有自己的任务,假如某个线程执行出错,这样就会导致整个进程的崩溃。所以为了信号处理函数正常运行,需要为信号处理函数设置单独的运行空间。另一种情况是递归函数将系统默认的栈空间用尽了,但是信号处理函数使用的栈是它实现在堆中分配的空间,而不是系统默认的栈,所以它仍旧可以正常工作。

    2. int sigaltstack(const stack_t * __restrict, stack_t * __restrict) 函数的二个参数都是 stack_t 结构的指针,存储了可替换信号栈的信息(栈的起始地址、栈的长度、状态)。第1个参数该结构存储了一个“可替换信号栈” 的位置及属性信息。第 2 个参数用来返回上一次建立的“可替换信号栈”的信息(如果有的话)。

      _STRUCT_SIGALTSTACK
      {
      	void            *ss_sp;         /* signal stack base */
      	__darwin_size_t ss_size;        /* signal stack length */
      	int             ss_flags;       /* SA_DISABLE and/or SA_ONSTACK */
      };
      typedef _STRUCT_SIGALTSTACK     stack_t; /* [???] signal stack */
      

      新创建的可替换信号栈,ss_flags 必须设置为 0。系统定义了 SIGSTKSZ 常量,可满足绝大多可替换信号栈的需求。

      /*
       * Structure used in sigaltstack call.
       */
      
      #define SS_ONSTACK      0x0001  /* take signal on signal stack */
      #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
      #define MINSIGSTKSZ     32768   /* (32K)minimum allowable stack */
      #define SIGSTKSZ        131072  /* (128K)recommended stack size */
      

      sigaltstack 系统调用通知内核“可替换信号栈”已经建立。

      ss_flagsSS_ONSTACK 时,表示进程当前正在“可替换信号栈”中执行,如果此时试图去建立一个新的“可替换信号栈”,那么会遇到 EPERM (禁止该动作) 的错误;为 SS_DISABLE 说明当前没有已建立的“可替换信号栈”,禁止建立“可替换信号栈”。

    3. int sigaction(int, const struct sigaction * __restrict, struct sigaction * __restrict);

      第一个函数表示需要处理的信号值,但不能是 SIGKILLSIGSTOP ,这两个信号的处理函数不允许用户重写,因为它们给超级用户提供了终止程序的方法( SIGKILL and SIGSTOP cannot be caught, blocked, or ignored);

      第二个和第三个参数是一个 sigaction 结构体。如果第二个参数不为空则代表将其指向信号处理函数,第三个参数不为空,则将之前的信号处理函数保存到该指针中。如果第二个参数为空,第三个参数不为空,则可以获取当前的信号处理函数。

      /*
       * Signal vector "template" used in sigaction call.
       */
      struct  sigaction {
      	union __sigaction_u __sigaction_u;  /* signal handler */
      	sigset_t sa_mask;               /* signal mask to apply */
      	int     sa_flags;               /* see signal options below */
      };
      

      sigaction 函数的 sa_flags 参数需要设置 SA_ONSTACK 标志,告诉内核信号处理函数的栈帧就在“可替换信号栈”上建立。

    2.3. C++ 异常处理

    c++ 异常处理的实现是依靠了标准库的 std::set_terminate(CPPExceptionTerminate) 函数。

    iOS 工程中某些功能的实现可能使用了C、C++等。假如抛出 C++ 异常,如果该异常可以被转换为 NSException,则走 OC 异常捕获机制,如果不能转换,则继续走 C++ 异常流程,也就是 default_terminate_handler。这个 C++ 异常的默认 terminate 函数内部调用 abort_message 函数,最后触发了一个 abort 调用,系统产生一个 SIGABRT 信号。

    在系统抛出 C++ 异常后,加一层 try...catch... 来判断该异常是否可以转换为 NSException,再重新抛出的C++异常。此时异常的现场堆栈已经消失,所以上层通过捕获 SIGABRT 信号是无法还原发生异常时的场景,即异常堆栈缺失。

    为什么?try...catch... 语句内部会调用 __cxa_rethrow() 抛出异常,__cxa_rethrow() 内部又会调用 unwindunwind 可以简单理解为函数调用的逆调用,主要用来清理函数调用过程中每个函数生成的局部变量,一直到最外层的 catch 语句所在的函数,并把控制移交给 catch 语句,这就是C++异常的堆栈消失原因。

    static void setEnabled(bool isEnabled)
    {
        if(isEnabled != g_isEnabled)
        {
            g_isEnabled = isEnabled;
            if(isEnabled)
            {
                initialize();
    
                ksid_generate(g_eventID);
                g_originalTerminateHandler = std::set_terminate(CPPExceptionTerminate);
            }
            else
            {
                std::set_terminate(g_originalTerminateHandler);
            }
            g_captureNextStackTrace = isEnabled;
        }
    }
    
    static void initialize()
    {
        static bool isInitialized = false;
        if(!isInitialized)
        {
            isInitialized = true;
            kssc_initCursor(&g_stackCursor, NULL, NULL);
        }
    }
    
    void kssc_initCursor(KSStackCursor *cursor,
                         void (*resetCursor)(KSStackCursor*),
                         bool (*advanceCursor)(KSStackCursor*))
    {
        cursor->symbolicate = kssymbolicator_symbolicate;
        cursor->advanceCursor = advanceCursor != NULL ? advanceCursor : g_advanceCursor;
        cursor->resetCursor = resetCursor != NULL ? resetCursor : kssc_resetCursor;
        cursor->resetCursor(cursor);
    }
    
    static void CPPExceptionTerminate(void)
    {
        ksmc_suspendEnvironment();
        KSLOG_DEBUG("Trapped c++ exception");
        const char* name = NULL;
        std::type_info* tinfo = __cxxabiv1::__cxa_current_exception_type();
        if(tinfo != NULL)
        {
            name = tinfo->name();
        }
        
        if(name == NULL || strcmp(name, "NSException") != 0)
        {
            kscm_notifyFatalExceptionCaptured(false);
            KSCrash_MonitorContext* crashContext = &g_monitorContext;
            memset(crashContext, 0, sizeof(*crashContext));
    
            char descriptionBuff[DESCRIPTION_BUFFER_LENGTH];
            const char* description = descriptionBuff;
            descriptionBuff[0] = 0;
    
            KSLOG_DEBUG("Discovering what kind of exception was thrown.");
            g_captureNextStackTrace = false;
            try
            {
                throw;
            }
            catch(std::exception& exc)
            {
                strncpy(descriptionBuff, exc.what(), sizeof(descriptionBuff));
            }
    #define CATCH_VALUE(TYPE, PRINTFTYPE) \
    catch(TYPE value)\
    { \
        snprintf(descriptionBuff, sizeof(descriptionBuff), "%" #PRINTFTYPE, value); \
    }
            CATCH_VALUE(char,                 d)
            CATCH_VALUE(short,                d)
            CATCH_VALUE(int,                  d)
            CATCH_VALUE(long,                ld)
            CATCH_VALUE(long long,          lld)
            CATCH_VALUE(unsigned char,        u)
            CATCH_VALUE(unsigned short,       u)
            CATCH_VALUE(unsigned int,         u)
            CATCH_VALUE(unsigned long,       lu)
            CATCH_VALUE(unsigned long long, llu)
            CATCH_VALUE(float,                f)
            CATCH_VALUE(double,               f)
            CATCH_VALUE(long double,         Lf)
            CATCH_VALUE(char*,                s)
            catch(...)
            {
                description = NULL;
            }
            g_captureNextStackTrace = g_isEnabled;
    
            // TODO: Should this be done here? Maybe better in the exception handler?
            KSMC_NEW_CONTEXT(machineContext);
            ksmc_getContextForThread(ksthread_self(), machineContext, true);
    
            KSLOG_DEBUG("Filling out context.");
            crashContext->crashType = KSCrashMonitorTypeCPPException;
            crashContext->eventID = g_eventID;
            crashContext->registersAreValid = false;
            crashContext->stackCursor = &g_stackCursor;
            crashContext->CPPException.name = name;
            crashContext->exceptionName = name;
            crashContext->crashReason = description;
            crashContext->offendingMachineContext = machineContext;
    
            kscm_handleException(crashContext);
        }
        else
        {
            KSLOG_DEBUG("Detected NSException. Letting the current NSException handler deal with it.");
        }
        ksmc_resumeEnvironment();
    
        KSLOG_DEBUG("Calling original terminate handler.");
        g_originalTerminateHandler();
    }
    

    2.4. Objective-C 异常处理

    对于 OC 层面的 NSException 异常处理较为容易,可以通过注册 NSUncaughtExceptionHandler 来捕获异常信息,通过 NSException 参数来做 Crash 信息的收集,交给数据上报组件。

    static void setEnabled(bool isEnabled)
    {
        if(isEnabled != g_isEnabled)
        {
            g_isEnabled = isEnabled;
            if(isEnabled)
            {
                KSLOG_DEBUG(@"Backing up original handler.");
                // 记录之前的 OC 异常处理函数
                g_previousUncaughtExceptionHandler = NSGetUncaughtExceptionHandler();
                
                KSLOG_DEBUG(@"Setting new handler.");
                // 设置新的 OC 异常处理函数
                NSSetUncaughtExceptionHandler(&handleException);
                KSCrash.sharedInstance.uncaughtExceptionHandler = &handleException;
            }
            else
            {
                KSLOG_DEBUG(@"Restoring original handler.");
                NSSetUncaughtExceptionHandler(g_previousUncaughtExceptionHandler);
            }
        }
    }
    

    2.5. 主线程死锁

    主线程死锁的检测和 ANR 的检测有些类似

    • 创建一个线程,在线程运行方法中用 do...while... 循环处理逻辑,加了 autorelease 避免内存过高

    • 有一个 awaitingResponse 属性和 watchdogPulse 方法。watchdogPulse 主要逻辑为设置 awaitingResponse 为 YES,切换到主线程中,设置 awaitingResponse 为 NO,

      - (void) watchdogPulse
      {
          __block id blockSelf = self;
          self.awaitingResponse = YES;
          dispatch_async(dispatch_get_main_queue(), ^
                         {
                             [blockSelf watchdogAnswer];
                         });
      }
      
    • 线程的执行方法里面不断循环,等待设置的 g_watchdogInterval 后判断 awaitingResponse 的属性值是不是初始状态的值,否则判断为死锁

      - (void) runMonitor
      {
          BOOL cancelled = NO;
          do
          {
              // Only do a watchdog check if the watchdog interval is > 0.
              // If the interval is <= 0, just idle until the user changes it.
              @autoreleasepool {
                  NSTimeInterval sleepInterval = g_watchdogInterval;
                  BOOL runWatchdogCheck = sleepInterval > 0;
                  if(!runWatchdogCheck)
                  {
                      sleepInterval = kIdleInterval;
                  }
                  [NSThread sleepForTimeInterval:sleepInterval];
                  cancelled = self.monitorThread.isCancelled;
                  if(!cancelled && runWatchdogCheck)
                  {
                      if(self.awaitingResponse)
                      {
                          [self handleDeadlock];
                      }
                      else
                      {
                          [self watchdogPulse];
                      }
                  }
              }
          } while (!cancelled);
      }
      

    2.6 Crash 的生成与保存

    2.6.1 Crash 日志的生成逻辑

    上面的部分讲过了 iOS 应用开发中的各种 crash 监控逻辑,接下来就应该分析下 crash 捕获后如何将 crash 信息记录下来,也就是保存到应用沙盒中。

    拿主线程死锁这种 crash 举例子,看看 KSCrash 是如何记录 crash 信息的。

    // KSCrashMonitor_Deadlock.m
    - (void) handleDeadlock
    {
        ksmc_suspendEnvironment();
        kscm_notifyFatalExceptionCaptured(false);
    
        KSMC_NEW_CONTEXT(machineContext);
        ksmc_getContextForThread(g_mainQueueThread, machineContext, false);
        KSStackCursor stackCursor;
        kssc_initWithMachineContext(&stackCursor, 100, machineContext);
        char eventID[37];
        ksid_generate(eventID);
    
        KSLOG_DEBUG(@"Filling out context.");
        KSCrash_MonitorContext* crashContext = &g_monitorContext;
        memset(crashContext, 0, sizeof(*crashContext));
        crashContext->crashType = KSCrashMonitorTypeMainThreadDeadlock;
        crashContext->eventID = eventID;
        crashContext->registersAreValid = false;
        crashContext->offendingMachineContext = machineContext;
        crashContext->stackCursor = &stackCursor;
        
        kscm_handleException(crashContext);
        ksmc_resumeEnvironment();
    
        KSLOG_DEBUG(@"Calling abort()");
        abort();
    }
    

    其他几个 crash 也是一样,异常信息经过包装交给 kscm_handleException() 函数处理。可以看到这个函数被其他几种 crash 捕获后所调用。

    在这里插入图片描述

    
    /** Start general exception processing.
     *
     * @oaram context Contextual information about the exception.
     */
    void kscm_handleException(struct KSCrash_MonitorContext* context)
    {
        context->requiresAsyncSafety = g_requiresAsyncSafety;
        if(g_crashedDuringExceptionHandling)
        {
            context->crashedDuringCrashHandling = true;
        }
        for(int i = 0; i < g_monitorsCount; i++)
        {
            Monitor* monitor = &g_monitors[i];
            // 判断当前的 crash 监控是开启状态
            if(isMonitorEnabled(monitor))
            {
                // 针对每种 crash 类型做一些额外的补充信息
                addContextualInfoToEvent(monitor, context);
            }
        }
        // 真正处理 crash 信息,保存 json 格式的 crash 信息
        g_onExceptionEvent(context);
    
        
        if(g_handlingFatalException && !g_crashedDuringExceptionHandling)
        {
            KSLOG_DEBUG("Exception is fatal. Restoring original handlers.");
            kscm_setActiveMonitors(KSCrashMonitorTypeNone);
        }
    }
    

    g_onExceptionEvent 是一个 block,声明为 static void (*g_onExceptionEvent)(struct KSCrash_MonitorContext* monitorContext);KSCrashMonitor.c 中被赋值

    void kscm_setEventCallback(void (*onEvent)(struct KSCrash_MonitorContext* monitorContext))
    {
        g_onExceptionEvent = onEvent;
    }
    

    kscm_setEventCallback() 函数在 KSCrashC.c 文件中被调用

    KSCrashMonitorType kscrash_install(const char* appName, const char* const installPath)
    {
        KSLOG_DEBUG("Installing crash reporter.");
    
        if(g_installed)
        {
            KSLOG_DEBUG("Crash reporter already installed.");
            return g_monitoring;
        }
        g_installed = 1;
    
        char path[KSFU_MAX_PATH_LENGTH];
        snprintf(path, sizeof(path), "%s/Reports", installPath);
        ksfu_makePath(path);
        kscrs_initialize(appName, path);
    
        snprintf(path, sizeof(path), "%s/Data", installPath);
        ksfu_makePath(path);
        snprintf(path, sizeof(path), "%s/Data/CrashState.json", installPath);
        kscrashstate_initialize(path);
    
        snprintf(g_consoleLogPath, sizeof(g_consoleLogPath), "%s/Data/ConsoleLog.txt", installPath);
        if(g_shouldPrintPreviousLog)
        {
            printPreviousLog(g_consoleLogPath);
        }
        kslog_setLogFilename(g_consoleLogPath, true);
        
        ksccd_init(60);
        // 设置 crash 发生时的 callback 函数
        kscm_setEventCallback(onCrash);
        KSCrashMonitorType monitors = kscrash_setMonitoring(g_monitoring);
    
        KSLOG_DEBUG("Installation complete.");
        return monitors;
    }
    
    /** Called when a crash occurs.
     *
     * This function gets passed as a callback to a crash handler.
     */
    static void onCrash(struct KSCrash_MonitorContext* monitorContext)
    {
        KSLOG_DEBUG("Updating application state to note crash.");
        kscrashstate_notifyAppCrash();
        monitorContext->consoleLogPath = g_shouldAddConsoleLogToReport ? g_consoleLogPath : NULL;
    
        // 正在处理 crash 的时候,发生了再次 crash
        if(monitorContext->crashedDuringCrashHandling)
        {
            kscrashreport_writeRecrashReport(monitorContext, g_lastCrashReportFilePath);
        }
        else
        {
            // 1. 先根据当前时间创建新的 crash 的文件路径
            char crashReportFilePath[KSFU_MAX_PATH_LENGTH];
            kscrs_getNextCrashReportPath(crashReportFilePath);
            // 2. 将新生成的文件路径保存到 g_lastCrashReportFilePath
            strncpy(g_lastCrashReportFilePath, crashReportFilePath, sizeof(g_lastCrashReportFilePath));
            // 3. 将新生成的文件路径传入函数进行 crash 写入
            kscrashreport_writeStandardReport(monitorContext, crashReportFilePath);
        }
    }
    

    接下来的函数就是具体的日志写入文件的实现。2个函数做的事情相似,都是格式化为 json 形式并写入文件。区别在于 crash 写入时如果再次发生 crash, 则走简易版的写入逻辑 kscrashreport_writeRecrashReport(),否则走标准的写入逻辑 kscrashreport_writeStandardReport()

    bool ksfu_openBufferedWriter(KSBufferedWriter* writer, const char* const path, char* writeBuffer, int writeBufferLength)
    {
        writer->buffer = writeBuffer;
        writer->bufferLength = writeBufferLength;
        writer->position = 0;
        /*
         open() 的第二个参数描述的是文件操作的权限
         #define O_RDONLY        0x0000         open for reading only
         #define O_WRONLY        0x0001         open for writing only
         #define O_RDWR          0x0002         open for reading and writing
         #define O_ACCMODE       0x0003         mask for above mode
         
         #define O_CREAT         0x0200         create if nonexistant
         #define O_TRUNC         0x0400         truncate to zero length
         #define O_EXCL          0x0800         error if already exists
         
         0755:即用户具有读/写/执行权限,组用户和其它用户具有读写权限;
         0644:即用户具有读写权限,组用户和其它用户具有只读权限;
         成功则返回文件描述符,若出现则返回 -1
         */
        writer->fd = open(path, O_RDWR | O_CREAT | O_EXCL, 0644);
        if(writer->fd < 0)
        {
            KSLOG_ERROR("Could not open crash report file %s: %s", path, strerror(errno));
            return false;
        }
        return true;
    }
    
    /**
     * Write a standard crash report to a file.
     *
     *  @param monitorContext Contextual information about the crash and environment.
     *                      The caller must fill this out before passing it in.
     *
     *  @param path The file to write to.
     */
    void kscrashreport_writeStandardReport(const struct KSCrash_MonitorContext* const monitorContext,
                                           const char* path)
    {
    		KSLOG_INFO("Writing crash report to %s", path);
        char writeBuffer[1024];
        KSBufferedWriter bufferedWriter;
    
        if(!ksfu_openBufferedWriter(&bufferedWriter, path, writeBuffer, sizeof(writeBuffer)))
        {
            return;
        }
    
        ksccd_freeze();
        
        KSJSONEncodeContext jsonContext;
        jsonContext.userData = &bufferedWriter;
        KSCrashReportWriter concreteWriter;
        KSCrashReportWriter* writer = &concreteWriter;
        prepareReportWriter(writer, &jsonContext);
    
        ksjson_beginEncode(getJsonContext(writer), true, addJSONData, &bufferedWriter);
    
        writer->beginObject(writer, KSCrashField_Report);
        {
            writeReportInfo(writer,
                            KSCrashField_Report,
                            KSCrashReportType_Standard,
                            monitorContext->eventID,
                            monitorContext->System.processName);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writeBinaryImages(writer, KSCrashField_BinaryImages);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writeProcessState(writer, KSCrashField_ProcessState, monitorContext);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writeSystemInfo(writer, KSCrashField_System, monitorContext);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writer->beginObject(writer, KSCrashField_Crash);
            {
                writeError(writer, KSCrashField_Error, monitorContext);
                ksfu_flushBufferedWriter(&bufferedWriter);
                writeAllThreads(writer,
                                KSCrashField_Threads,
                                monitorContext,
                                g_introspectionRules.enabled);
                ksfu_flushBufferedWriter(&bufferedWriter);
            }
            writer->endContainer(writer);
    
            if(g_userInfoJSON != NULL)
            {
                addJSONElement(writer, KSCrashField_User, g_userInfoJSON, false);
                ksfu_flushBufferedWriter(&bufferedWriter);
            }
            else
            {
                writer->beginObject(writer, KSCrashField_User);
            }
            if(g_userSectionWriteCallback != NULL)
            {
                ksfu_flushBufferedWriter(&bufferedWriter);
                g_userSectionWriteCallback(writer);
            }
            writer->endContainer(writer);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writeDebugInfo(writer, KSCrashField_Debug, monitorContext);
        }
        writer->endContainer(writer);
        
        ksjson_endEncode(getJsonContext(writer));
        ksfu_closeBufferedWriter(&bufferedWriter);
        ksccd_unfreeze();
    }
    
    /** Write a minimal crash report to a file.
     *
     * @param monitorContext Contextual information about the crash and environment.
     *                       The caller must fill this out before passing it in.
     *
     * @param path The file to write to.
     */
    void kscrashreport_writeRecrashReport(const struct KSCrash_MonitorContext* const monitorContext,
                                          const char* path)
    {
      char writeBuffer[1024];
        KSBufferedWriter bufferedWriter;
        static char tempPath[KSFU_MAX_PATH_LENGTH];
        // 将传递过来的上份 crash report 文件名路径(/var/mobile/Containers/Data/Application/******/Library/Caches/KSCrash/Test/Reports/Test-report-******.json)修改为去掉 .json ,加上 .old 成为新的文件路径 /var/mobile/Containers/Data/Application/******/Library/Caches/KSCrash/Test/Reports/Test-report-******.old
    
        strncpy(tempPath, path, sizeof(tempPath) - 10);
        strncpy(tempPath + strlen(tempPath) - 5, ".old", 5);
        KSLOG_INFO("Writing recrash report to %s", path);
    
        if(rename(path, tempPath) < 0)
        {
            KSLOG_ERROR("Could not rename %s to %s: %s", path, tempPath, strerror(errno));
        }
        // 根据传入路径来打开内存写入需要的文件
        if(!ksfu_openBufferedWriter(&bufferedWriter, path, writeBuffer, sizeof(writeBuffer)))
        {
            return;
        }
    
        ksccd_freeze();
        // json 解析的 c 代码
        KSJSONEncodeContext jsonContext;
        jsonContext.userData = &bufferedWriter;
        KSCrashReportWriter concreteWriter;
        KSCrashReportWriter* writer = &concreteWriter;
        prepareReportWriter(writer, &jsonContext);
    
        ksjson_beginEncode(getJsonContext(writer), true, addJSONData, &bufferedWriter);
    
        writer->beginObject(writer, KSCrashField_Report);
        {
            writeRecrash(writer, KSCrashField_RecrashReport, tempPath);
            ksfu_flushBufferedWriter(&bufferedWriter);
            if(remove(tempPath) < 0)
            {
                KSLOG_ERROR("Could not remove %s: %s", tempPath, strerror(errno));
            }
            writeReportInfo(writer,
                            KSCrashField_Report,
                            KSCrashReportType_Minimal,
                            monitorContext->eventID,
                            monitorContext->System.processName);
            ksfu_flushBufferedWriter(&bufferedWriter);
    
            writer->beginObject(writer, KSCrashField_Crash);
            {
                writeError(writer, KSCrashField_Error, monitorContext);
                ksfu_flushBufferedWriter(&bufferedWriter);
                int threadIndex = ksmc_indexOfThread(monitorContext->offendingMachineContext,
                                                     ksmc_getThreadFromContext(monitorContext->offendingMachineContext));
                writeThread(writer,
                            KSCrashField_CrashedThread,
                            monitorContext,
                            monitorContext->offendingMachineContext,
                            threadIndex,
                            false);
                ksfu_flushBufferedWriter(&bufferedWriter);
            }
            writer->endContainer(writer);
        }
        writer->endContainer(writer);
    
        ksjson_endEncode(getJsonContext(writer));
        ksfu_closeBufferedWriter(&bufferedWriter);
        ksccd_unfreeze();
    }
    
    2.6.2 Crash 日志的读取逻辑

    当前 App 在 Crash 之后,KSCrash 将数据保存到 App 沙盒目录下,App 下次启动后我们读取存储的 crash 文件,然后处理数据并上传。

    App 启动后函数调用:

    [KSCrashInstallation sendAllReportsWithCompletion:] -> [KSCrash sendAllReportsWithCompletion:] -> [KSCrash allReports] -> [KSCrash reportWithIntID:] ->[KSCrash loadCrashReportJSONWithID:] -> kscrs_readReport

    sendAllReportsWithCompletion 里读取沙盒里的Crash 数据。

    // 先通过读取文件夹,遍历文件夹内的文件数量来判断 crash 报告的个数
    static int getReportCount()
    {
        int count = 0;
        DIR* dir = opendir(g_reportsPath);
        if(dir == NULL)
        {
            KSLOG_ERROR("Could not open directory %s", g_reportsPath);
            goto done;
        }
        struct dirent* ent;
        while((ent = readdir(dir)) != NULL)
        {
            if(getReportIDFromFilename(ent->d_name) > 0)
            {
                count++;
            }
        }
    
    done:
        if(dir != NULL)
        {
            closedir(dir);
        }
        return count;
    }
    
    // 通过 crash 文件个数、文件夹信息去遍历,一次获取到文件名(文件名的最后一部分就是 reportID),拿到 reportID 再去读取 crash 报告内的文件内容,写入数组
    - (NSArray*) allReports
    {
        int reportCount = kscrash_getReportCount();
        int64_t reportIDs[reportCount];
        reportCount = kscrash_getReportIDs(reportIDs, reportCount);
        NSMutableArray* reports = [NSMutableArray arrayWithCapacity:(NSUInteger)reportCount];
        for(int i = 0; i < reportCount; i++)
        {
            NSDictionary* report = [self reportWithIntID:reportIDs[i]];
            if(report != nil)
            {
                [reports addObject:report];
            }
        }
        
        return reports;
    }
    
    //  根据 reportID 找到 crash 信息
    - (NSDictionary*) reportWithIntID:(int64_t) reportID
    {
        NSData* jsonData = [self loadCrashReportJSONWithID:reportID];
        if(jsonData == nil)
        {
            return nil;
        }
    
        NSError* error = nil;
        NSMutableDictionary* crashReport = [KSJSONCodec decode:jsonData
                                                       options:KSJSONDecodeOptionIgnoreNullInArray |
                                                               KSJSONDecodeOptionIgnoreNullInObject |
                                                               KSJSONDecodeOptionKeepPartialObject
                                                         error:&error];
        if(error != nil)
        {
            KSLOG_ERROR(@"Encountered error loading crash report %" PRIx64 ": %@", reportID, error);
        }
        if(crashReport == nil)
        {
            KSLOG_ERROR(@"Could not load crash report");
            return nil;
        }
        [self doctorReport:crashReport];
    
        return crashReport;
    }
    
    //  reportID 读取 crash 内容并转换为 NSData 类型
    - (NSData*) loadCrashReportJSONWithID:(int64_t) reportID
    {
        char* report = kscrash_readReport(reportID);
        if(report != NULL)
        {
            return [NSData dataWithBytesNoCopy:report length:strlen(report) freeWhenDone:YES];
        }
        return nil;
    }
    
    // reportID 读取 crash 数据到 char 类型
    char* kscrash_readReport(int64_t reportID)
    {
        if(reportID <= 0)
        {
            KSLOG_ERROR("Report ID was %" PRIx64, reportID);
            return NULL;
        }
    
        char* rawReport = kscrs_readReport(reportID);
        if(rawReport == NULL)
        {
            KSLOG_ERROR("Failed to load report ID %" PRIx64, reportID);
            return NULL;
        }
    
        char* fixedReport = kscrf_fixupCrashReport(rawReport);
        if(fixedReport == NULL)
        {
            KSLOG_ERROR("Failed to fixup report ID %" PRIx64, reportID);
        }
    
        free(rawReport);
        return fixedReport;
    }
    
    // 多线程加锁,通过 reportID 执行 c 函数 getCrashReportPathByID,将路径设置到 path 上。然后执行 ksfu_readEntireFile 读取 crash 信息到 result
    char* kscrs_readReport(int64_t reportID)
    {
        pthread_mutex_lock(&g_mutex);
        char path[KSCRS_MAX_PATH_LENGTH];
        getCrashReportPathByID(reportID, path);
        char* result;
        ksfu_readEntireFile(path, &result, NULL, 2000000);
        pthread_mutex_unlock(&g_mutex);
        return result;
    }
    
    int kscrash_getReportIDs(int64_t* reportIDs, int count)
    {
        return kscrs_getReportIDs(reportIDs, count);
    }
    
    int kscrs_getReportIDs(int64_t* reportIDs, int count)
    {
        pthread_mutex_lock(&g_mutex);
        count = getReportIDs(reportIDs, count);
        pthread_mutex_unlock(&g_mutex);
        return count;
    }
    // 循环读取文件夹内容,根据 ent->d_name 调用 getReportIDFromFilename 函数,来获取 reportID,循环内部填充数组
    static int getReportIDs(int64_t* reportIDs, int count)
    {
        int index = 0;
        DIR* dir = opendir(g_reportsPath);
        if(dir == NULL)
        {
            KSLOG_ERROR("Could not open directory %s", g_reportsPath);
            goto done;
        }
    
        struct dirent* ent;
        while((ent = readdir(dir)) != NULL && index < count)
        {
            int64_t reportID = getReportIDFromFilename(ent->d_name);
            if(reportID > 0)
            {
                reportIDs[index++] = reportID;
            }
        }
    
        qsort(reportIDs, (unsigned)count, sizeof(reportIDs[0]), compareInt64);
    
    done:
        if(dir != NULL)
        {
            closedir(dir);
        }
        return index;
    }
    
    // sprintf(参数1, 格式2) 函数将格式2的值返回到参数1上,然后执行 sscanf(参数1, 参数2, 参数3),函数将字符串参数1的内容,按照参数2的格式,写入到参数3上。crash 文件命名为 "App名称-report-reportID.json"
    static int64_t getReportIDFromFilename(const char* filename)
    {
        char scanFormat[100];
        sprintf(scanFormat, "%s-report-%%" PRIx64 ".json", g_appName);
        
        int64_t reportID = 0;
        sscanf(filename, scanFormat, &reportID);
        return reportID;
    }
    

    在这里插入图片描述

    2.7 前端 js 相关的 Crash 的监控

    2.7.1 JavascriptCore 异常监控

    这部分简单粗暴,直接通过 JSContext 对象的 exceptionHandler 属性来监控,比如下面的代码

    jsContext.exceptionHandler = ^(JSContext *context, JSValue *exception) {
        // 处理 jscore 相关的异常信息    
    };
    
    2.7.2 h5 页面异常监控

    当 h5 页面内的 Javascript 运行异常时会 window 对象会触发 ErrorEvent 接口的 error 事件,并执行 window.onerror()

    window.onerror = function (msg, url, lineNumber, columnNumber, error) {
       // 处理异常信息
    };
    

    在这里插入图片描述

    2.7.3 React Native 异常监控

    小实验:下图是写了一个 RN Demo 工程,在 Debug Text 控件上加了事件监听代码,内部人为触发 crash

    <Text style={styles.sectionTitle} onPress={()=>{1+qw;}}>Debug</Text>
    

    对比组1:

    条件: iOS 项目 debug 模式。在 RN 端增加了异常处理的代码。

    模拟器点击 command + d 调出面板,选择 Debug,打开 Chrome 浏览器, Mac 下快捷键 Command + Option + J 打开调试面板,就可以像调试 React 一样调试 RN 代码了。
    在这里插入图片描述

    查看到 crash stack 后点击可以跳转到 sourceMap 的地方。

    Tips:RN 项目打 Release 包

    • 在项目根目录下创建文件夹( release_iOS),作为资源的输出文件夹

    • 在终端切换到工程目录,然后执行下面的代码

      react-native bundle --entry-file index.js --platform ios --dev false --bundle-output release_ios/main.jsbundle --assets-dest release_iOS --sourcemap-output release_ios/index.ios.map;
      
    • 将 release_iOS 文件夹内的 .jsbundleassets 文件夹内容拖入到 iOS 工程中即可

    对比组2:

    条件:iOS 项目 release 模式。在 RN 端不增加异常处理代码

    操作:运行 iOS 工程,点击按钮模拟 crash

    现象:iOS 项目奔溃。截图以及日志如下:

    在这里插入图片描述

    2020-06-22 22:26:03.318 [info][tid:main][RCTRootView.m:294] Running application todos ({
        initialProps =     {
        };
        rootTag = 1;
    })
    2020-06-22 22:26:03.490 [info][tid:com.facebook.react.JavaScript] Running "todos" with {"rootTag":1,"initialProps":{}}
    2020-06-22 22:27:38.673 [error][tid:com.facebook.react.JavaScript] ReferenceError: Can't find variable: qw
    2020-06-22 22:27:38.675 [fatal][tid:com.facebook.react.ExceptionsManagerQueue] Unhandled JS Exception: ReferenceError: Can't find variable: qw
    2020-06-22 22:27:38.691300+0800 todos[16790:314161] *** Terminating app due to uncaught exception 'RCTFatalException: Unhandled JS Exception: ReferenceError: Can't find variable: qw', reason: 'Unhandled JS Exception: ReferenceError: Can't find variable: qw, stack:
    onPress@397:1821
    <unknown>@203:3896
    _performSideEffectsForTransition@210:9689
    _performSideEffectsForTransition@(null):(null)
    _receiveSignal@210:8425
    _receiveSignal@(null):(null)
    touchableHandleResponderRelease@210:5671
    touchableHandleResponderRelease@(null):(null)
    onResponderRelease@203:3006
    b@97:1125
    S@97:1268
    w@97:1322
    R@97:1617
    M@97:2401
    forEach@(null):(null)
    U@97:2201
    <unknown>@97:13818
    Pe@97:90199
    Re@97:13478
    Ie@97:13664
    receiveTouches@97:14448
    value@27:3544
    <unknown>@27:840
    value@27:2798
    value@27:812
    value@(null):(null)
    '
    *** First throw call stack:
    (
    	0   CoreFoundation                      0x00007fff23e3cf0e __exceptionPreprocess + 350
    	1   libobjc.A.dylib                     0x00007fff50ba89b2 objc_exception_throw + 48
    	2   todos                               0x00000001017b0510 RCTFormatError + 0
    	3   todos                               0x000000010182d8ca -[RCTExceptionsManager reportFatal:stack:exceptionId:suppressRedBox:] + 503
    	4   todos                               0x000000010182e34e -[RCTExceptionsManager reportException:] + 1658
    	5   CoreFoundation                      0x00007fff23e43e8c __invoking___ + 140
    	6   CoreFoundation                      0x00007fff23e41071 -[NSInvocation invoke] + 321
    	7   CoreFoundation                      0x00007fff23e41344 -[NSInvocation invokeWithTarget:] + 68
    	8   todos                               0x00000001017e07fa -[RCTModuleMethod invokeWithBridge:module:arguments:] + 578
    	9   todos                               0x00000001017e2a84 _ZN8facebook5reactL11invokeInnerEP9RCTBridgeP13RCTModuleDatajRKN5folly7dynamicE + 246
    	10  todos                               0x00000001017e280c ___ZN8facebook5react15RCTNativeModule6invokeEjON5folly7dynamicEi_block_invoke + 78
    	11  libdispatch.dylib                   0x00000001025b5f11 _dispatch_call_block_and_release + 12
    	12  libdispatch.dylib                   0x00000001025b6e8e _dispatch_client_callout + 8
    	13  libdispatch.dylib                   0x00000001025bd6fd _dispatch_lane_serial_drain + 788
    	14  libdispatch.dylib                   0x00000001025be28f _dispatch_lane_invoke + 422
    	15  libdispatch.dylib                   0x00000001025c9b65 _dispatch_workloop_worker_thread + 719
    	16  libsystem_pthread.dylib             0x00007fff51c08a3d _pthread_wqthread + 290
    	17  libsystem_pthread.dylib             0x00007fff51c07b77 start_wqthread + 15
    )
    libc++abi.dylib: terminating with uncaught exception of type NSException
    (lldb) 
    

    Tips:如何在 RN release 模式下调试(看到 js 侧的 console 信息)

    • AppDelegate.m 中引入 #import <React/RCTLog.h>
    • - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 中加入 RCTSetLogThreshold(RCTLogLevelTrace);

    对比组3:

    条件:iOS 项目 release 模式。在 RN 端增加异常处理代码。

    global.ErrorUtils.setGlobalHandler((e) => {
      console.log(e);
      let message = { name: e.name,
                    message: e.message,
                    stack: e.stack
      };
      axios.get('http://192.168.1.100:8888/test.php', {
      	params: { 'message': JSON.stringify(message) }
      }).then(function (response) {
      		console.log(response)
      }).catch(function (error) {
      console.log(error)
      });
    }, true)
    

    操作:运行 iOS 工程,点击按钮模拟 crash。

    现象:iOS 项目不奔溃。日志信息如下,对比 bundle 包中的 js。
    在这里插入图片描述
    结论:

    在 RN 项目中,如果发生了 crash 则会在 Native 侧有相应体现。如果 RN 侧写了 crash 捕获的代码,则 Native 侧不会奔溃。如果 RN 侧的 crash 没有捕获,则 Native 直接奔溃。

    RN 项目写了 crash 监控,监控后将堆栈信息打印出来发现对应的 js 信息是经过 webpack 处理的,crash 分析难度很大。所以我们针对 RN 的 crash 需要在 RN 侧写监控代码,监控后需要上报,此外针对监控后的信息需要写专门的 crash 信息还原给你,也就是 sourceMap 解析。

    2.7.3.1 js 逻辑错误

    写过 RN 的人都知道在 DEBUG 模式下 js 代码有问题则会产生红屏,在 RELEASE 模式下则会白屏或者闪退,为了体验和质量把控需要做异常监控。

    在看 RN 源码时候发现了 ErrorUtils,看代码可以设置处理错误信息。

    /**
     * Copyright (c) Facebook, Inc. and its affiliates.
     *
     * This source code is licensed under the MIT license found in the
     * LICENSE file in the root directory of this source tree.
     *
     * @format
     * @flow strict
     * @polyfill
     */
    
    let _inGuard = 0;
    
    type ErrorHandler = (error: mixed, isFatal: boolean) => void;
    type Fn<Args, Return> = (...Args) => Return;
    
    /**
     * This is the error handler that is called when we encounter an exception
     * when loading a module. This will report any errors encountered before
     * ExceptionsManager is configured.
     */
    let _globalHandler: ErrorHandler = function onError(
      e: mixed,
      isFatal: boolean,
    ) {
      throw e;
    };
    
    /**
     * The particular require runtime that we are using looks for a global
     * `ErrorUtils` object and if it exists, then it requires modules with the
     * error handler specified via ErrorUtils.setGlobalHandler by calling the
     * require function with applyWithGuard. Since the require module is loaded
     * before any of the modules, this ErrorUtils must be defined (and the handler
     * set) globally before requiring anything.
     */
    const ErrorUtils = {
      setGlobalHandler(fun: ErrorHandler): void {
        _globalHandler = fun;
      },
      getGlobalHandler(): ErrorHandler {
        return _globalHandler;
      },
      reportError(error: mixed): void {
        _globalHandler && _globalHandler(error, false);
      },
      reportFatalError(error: mixed): void {
        // NOTE: This has an untyped call site in Metro.
        _globalHandler && _globalHandler(error, true);
      },
      applyWithGuard<TArgs: $ReadOnlyArray<mixed>, TOut>(
        fun: Fn<TArgs, TOut>,
        context?: ?mixed,
        args?: ?TArgs,
        // Unused, but some code synced from www sets it to null.
        unused_onError?: null,
        // Some callers pass a name here, which we ignore.
        unused_name?: ?string,
      ): ?TOut {
        try {
          _inGuard++;
          // $FlowFixMe: TODO T48204745 (1) apply(context, null) is fine. (2) array -> rest array should work
          return fun.apply(context, args);
        } catch (e) {
          ErrorUtils.reportError(e);
        } finally {
          _inGuard--;
        }
        return null;
      },
      applyWithGuardIfNeeded<TArgs: $ReadOnlyArray<mixed>, TOut>(
        fun: Fn<TArgs, TOut>,
        context?: ?mixed,
        args?: ?TArgs,
      ): ?TOut {
        if (ErrorUtils.inGuard()) {
          // $FlowFixMe: TODO T48204745 (1) apply(context, null) is fine. (2) array -> rest array should work
          return fun.apply(context, args);
        } else {
          ErrorUtils.applyWithGuard(fun, context, args);
        }
        return null;
      },
      inGuard(): boolean {
        return !!_inGuard;
      },
      guard<TArgs: $ReadOnlyArray<mixed>, TOut>(
        fun: Fn<TArgs, TOut>,
        name?: ?string,
        context?: ?mixed,
      ): ?(...TArgs) => ?TOut {
        // TODO: (moti) T48204753 Make sure this warning is never hit and remove it - types
        // should be sufficient.
        if (typeof fun !== 'function') {
          console.warn('A function must be passed to ErrorUtils.guard, got ', fun);
          return null;
        }
        const guardName = name ?? fun.name ?? '<generated guard>';
        function guarded(...args: TArgs): ?TOut {
          return ErrorUtils.applyWithGuard(
            fun,
            context ?? this,
            args,
            null,
            guardName,
          );
        }
    
        return guarded;
      },
    };
    
    global.ErrorUtils = ErrorUtils;
    
    export type ErrorUtilsT = typeof ErrorUtils;
    

    所以 RN 的异常可以使用 global.ErrorUtils 来设置错误处理。举个例子:

    global.ErrorUtils.setGlobalHandler(e => {
       // e.name e.message e.stack
    }, true);
    
    2.7.3.2 组件问题

    其实对于 RN 的 crash 处理还有个需要注意的就是 React Error Boundaries详细资料

    过去,组件内的 JavaScript 错误会导致 React 的内部状态被破坏,并且在下一次渲染时 产生 可能无法追踪的 错误。这些错误基本上是由较早的其他代码(非 React 组件代码)错误引起的,但 React 并没有提供一种在组件中优雅处理这些错误的方式,也无法从错误中恢复。

    部分 UI 的 JavaScript 错误不应该导致整个应用崩溃,为了解决这个问题,React 16 引入了一个新的概念 —— 错误边界。

    错误边界是一种 React 组件,这种组件可以捕获并打印发生在其子组件树任何位置的 JavaScript 错误,并且,它会渲染出备用 UI,而不是渲染那些崩溃了的子组件树。错误边界在渲染期间、生命周期方法和整个组件树的构造函数中捕获错误。

    它能捕获子组件生命周期函数中的异常,包括构造函数(constructor)和 render 函数

    而不能捕获以下异常:

    • Event handlers(事件处理函数)
    • Asynchronous code(异步代码,如setTimeout、promise等)
    • Server side rendering(服务端渲染)
    • Errors thrown in the error boundary itself (rather than its children)(异常边界组件本身抛出的异常)

    所以可以通过异常边界组件捕获组件生命周期内的所有异常然后渲染兜底组件 ,防止 App crash,提高用户体验。也可引导用户反馈问题,方便问题的排查和修复

    至此 RN 的 crash 分为2种,分别是 js 逻辑错误、组件 js 错误,都已经被监控处理了。接下来就看看如何从工程化层面解决这些问题

    2.7.4 RN Crash 还原

    SourceMap 文件对于前端日志的解析至关重要,SourceMap 文件中各个参数和如何计算的步骤都在里面有写,可以查看这篇文章

    有了 SourceMap 文件,借助于 mozilla source-map 项目,可以很好的还原 RN 的 crash 日志。

    我写了个 NodeJS 脚本,代码如下

    var fs = require('fs');
    var sourceMap = require('source-map');
    var arguments = process.argv.splice(2);
    
    function parseJSError(aLine, aColumn) {
        fs.readFile('./index.ios.map', 'utf8', function (err, data) {
            const whatever =  sourceMap.SourceMapConsumer.with(data, null, consumer => {
                // 读取 crash 日志的行号、列号
                let parseData = consumer.originalPositionFor({
                    line: parseInt(aLine),
                    column: parseInt(aColumn)
                });
                // 输出到控制台
                console.log(parseData);
                // 输出到文件中
                fs.writeFileSync('./parsed.txt', JSON.stringify(parseData) + '\n', 'utf8', function(err) {  
                    if(err) {  
                        console.log(err);
                    }
                });
            });
        });
    }
    
    var line = arguments[0];
    var column = arguments[1];
    parseJSError(line, column);
    

    接下来做个实验,还是上述的 todos 项目。

    1. 在 Text 的点击事件上模拟 crash

      <Text style={styles.sectionTitle} onPress={()=>{1+qw;}}>Debug</Text>
      
    2. 将 RN 项目打 bundle 包、产出 sourceMap 文件。执行命令,

      react-native bundle --entry-file index.js --platform android --dev false --bundle-output release_ios/main.jsbundle --assets-dest release_iOS --sourcemap-output release_ios/index.android.map;
      

      因为高频使用,所以给 iterm2 增加 alias 别名设置,修改 .zshrc 文件

      alias RNRelease='react-native bundle --entry-file index.js --platform ios --dev false --bundle-output release_ios/main.jsbundle --assets-dest release_iOS --sourcemap-output release_ios/index.ios.map;' # RN 打 Release 包
      
    3. 将 js bundle 和图片资源拷贝到 Xcode 工程中

    4. 点击模拟 crash,将日志下面的行号和列号拷贝,在 Node 项目下,执行下面命令

      node index.js 397 1822
      
    5. 拿脚本解析好的行号、列号、文件信息去和源代码文件比较,结果很正确。

    在这里插入图片描述

    2.7.5 SourceMap 解析系统设计

    目的:通过平台可以将 RN 项目线上 crash 可以还原到具体的文件、代码行数、代码列数。可以看到具体的代码,可以看到 RN stack trace、提供源文件下载功能。

    1. 打包系统下管理的服务器:
      • 生产环境下打包才生成 source map 文件
      • 存储打包前的所有文件(install)
    2. 开发产品侧 RN 分析界面。点击收集到的 RN crash,在详情页可以看到具体的文件、代码行数、代码列数。可以看到具体的代码,可以看到 RN stack trace、Native stack trace。(具体技术实现上面讲过了)
    3. 由于 souece map 文件较大,RN 解析过长虽然不久,但是是对计算资源的消耗,所以需要设计高效读取方式
    4. SourceMap 在 iOS、Android 模式下不一样,所以 SoureceMap 存储需要区分 os。

    3. KSCrash 的使用包装

    然后再封装自己的 Crash 处理逻辑。比如要做的事情就是:

    • 继承自 KSCrashInstallation 这个抽象类,设置初始化工作(抽象类比如 NSURLProtocol 必须继承后使用),实现抽象类中的 sink 方法。

      /**
       * Crash system installation which handles backend-specific details.
       *
       * Only one installation can be installed at a time.
       *
       * This is an abstract class.
       */
      @interface KSCrashInstallation : NSObject
      
      #import "CMCrashInstallation.h"
      #import <KSCrash/KSCrashInstallation+Private.h>
      #import "CMCrashReporterSink.h"
      
      @implementation CMCrashInstallation
      
      + (instancetype)sharedInstance {
          static CMCrashInstallation *sharedInstance = nil;
          static dispatch_once_t onceToken;
          dispatch_once(&onceToken, ^{
              sharedInstance = [[CMCrashInstallation alloc] init];
          });
          return sharedInstance;
      }
      
      - (id)init {
          return [super initWithRequiredProperties: nil];
      }
      
      - (id<KSCrashReportFilter>)sink {
          CMCrashReporterSink *sink = [[CMCrashReporterSink alloc] init];
          return [sink defaultCrashReportFilterSetAppleFmt];
      }
      
      @end
      
    • sink 方法内部的 CMCrashReporterSink 类,遵循了 KSCrashReportFilter 协议,声明了公有方法 defaultCrashReportFilterSetAppleFmt

      // .h
      #import <Foundation/Foundation.h>
      #import <KSCrash/KSCrashReportFilter.h>
      
      @interface CMCrashReporterSink : NSObject<KSCrashReportFilter>
      
      - (id <KSCrashReportFilter>) defaultCrashReportFilterSetAppleFmt;
      
      @end
      
      // .m
      #pragma mark - public Method
      
      - (id <KSCrashReportFilter>) defaultCrashReportFilterSetAppleFmt
      {
          return [KSCrashReportFilterPipeline filterWithFilters:
                  [CMCrashReportFilterAppleFmt filterWithReportStyle:KSAppleReportStyleSymbolicatedSideBySide],
                  self,
                  nil];
      }
      

      其中 defaultCrashReportFilterSetAppleFmt 方法内部返回了一个 KSCrashReportFilterPipeline 类方法 filterWithFilters 的结果。

      CMCrashReportFilterAppleFmt 是一个继承自 KSCrashReportFilterAppleFmt 的类,遵循了 KSCrashReportFilter 协议。协议方法允许开发者处理 Crash 的数据格式。

      /** Filter the specified reports.
       *
       * @param reports The reports to process.
       * @param onCompletion Block to call when processing is complete.
       */
      - (void) filterReports:(NSArray*) reports
                onCompletion:(KSCrashReportFilterCompletion) onCompletion;
      
      #import <KSCrash/KSCrashReportFilterAppleFmt.h>
      
      @interface CMCrashReportFilterAppleFmt : KSCrashReportFilterAppleFmt<KSCrashReportFilter>
      
      @end
        
      // .m
      - (void) filterReports:(NSArray*)reports onCompletion:(KSCrashReportFilterCompletion)onCompletion
        {
          NSMutableArray* filteredReports = [NSMutableArray arrayWithCapacity:[reports count]];
          for(NSDictionary *report in reports){
            if([self majorVersion:report] == kExpectedMajorVersion){
              id monitorInfo = [self generateMonitorInfoFromCrashReport:report];
              if(monitorInfo != nil){
                [filteredReports addObject:monitorInfo];
              }
            }
          }
          kscrash_callCompletion(onCompletion, filteredReports, YES, nil);
      }
      
      /**
       @brief 获取Crash JSON中的crash时间、mach name、signal name和apple report
       */
      - (NSDictionary *)generateMonitorInfoFromCrashReport:(NSDictionary *)crashReport
      {
          NSDictionary *infoReport = [crashReport objectForKey:@"report"];
          // ...
          id appleReport = [self toAppleFormat:crashReport];
          
          NSMutableDictionary *info = [NSMutableDictionary dictionary];
          [info setValue:crashTime forKey:@"crashTime"];
          [info setValue:appleReport forKey:@"appleReport"];
          [info setValue:userException forKey:@"userException"];
          [info setValue:userInfo forKey:@"custom"];
          
          return [info copy];
      }
      
      /**
       * A pipeline of filters. Reports get passed through each subfilter in order.
       *
       * Input: Depends on what's in the pipeline.
       * Output: Depends on what's in the pipeline.
       */
      @interface KSCrashReportFilterPipeline : NSObject <KSCrashReportFilter>
      
    • APM 能力中为 Crash 模块设置一个启动器。启动器内部设置 KSCrash 的初始化工作,以及触发 Crash 时候监控所需数据的组装。比如:SESSION_ID、App 启动时间、App 名称、崩溃时间、App 版本号、当前页面信息等基础信息。

      /** C Function to call during a crash report to give the callee an opportunity to
       * add to the report. NULL = ignore.
       *
       * WARNING: Only call async-safe functions from this function! DO NOT call
       * Objective-C methods!!!
       */
      @property(atomic,readwrite,assign) KSReportWriteCallback onCrash;
      
      + (instancetype)sharedInstance
      {
          static CMCrashMonitor *_sharedManager = nil;
          static dispatch_once_t onceToken;
          dispatch_once(&onceToken, ^{
              _sharedManager = [[CMCrashMonitor alloc] init];
          });
          return _sharedManager;
      }
      
      
      #pragma mark - public Method
      
      - (void)startMonitor
      {
          CMMLog(@"crash monitor started");
      
      #ifdef DEBUG
          BOOL _trackingCrashOnDebug = [CMMonitorConfig sharedInstance].trackingCrashOnDebug;
          if (_trackingCrashOnDebug) {
              [self installKSCrash];
          }
      #else
          [self installKSCrash];
      #endif
      }
      
      #pragma mark - private method
      
      static void onCrash(const KSCrashReportWriter* writer)
      {
          NSString *sessionId = [NSString stringWithFormat:@"\"%@\"", ***]];
          writer->addJSONElement(writer, "SESSION_ID", [sessionId UTF8String], true);
          
          NSString *appLaunchTime = ***;
          writer->addJSONElement(writer, "USER_APP_START_DATE", [[NSString stringWithFormat:@"\"%@\"", appLaunchTime] UTF8String], true);
          // ...
      }
      
      - (void)installKSCrash
      {
          [[CMCrashInstallation sharedInstance] install];
          [[CMCrashInstallation sharedInstance] sendAllReportsWithCompletion:nil];
          [CMCrashInstallation sharedInstance].onCrash = onCrash;
          dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(5.f * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
              _isCanAddCrashCount = NO;
          });
      }
      

      installKSCrash 方法中调用了 [[CMCrashInstallation sharedInstance] sendAllReportsWithCompletion: nil],内部实现如下

      - (void) sendAllReportsWithCompletion:(KSCrashReportFilterCompletion) onCompletion
      {
          NSError* error = [self validateProperties];
          if(error != nil)
          {
              if(onCompletion != nil)
              {
                  onCompletion(nil, NO, error);
              }
              return;
          }
      
          id<KSCrashReportFilter> sink = [self sink];
          if(sink == nil)
          {
              onCompletion(nil, NO, [NSError errorWithDomain:[[self class] description]
                                                        code:0
                                                 description:@"Sink was nil (subclasses must implement method \"sink\")"]);
              return;
          }
          
          sink = [KSCrashReportFilterPipeline filterWithFilters:self.prependedFilters, sink, nil];
      
          KSCrash* handler = [KSCrash sharedInstance];
          handler.sink = sink;
          [handler sendAllReportsWithCompletion:onCompletion];
      }
      

      方法内部将 KSCrashInstallationsink 赋值给 KSCrash 对象。 内部还是调用了 KSCrashsendAllReportsWithCompletion 方法,实现如下

      - (void) sendAllReportsWithCompletion:(KSCrashReportFilterCompletion) onCompletion
      {
          NSArray* reports = [self allReports];
          
          KSLOG_INFO(@"Sending %d crash reports", [reports count]);
          
          [self sendReports:reports
               onCompletion:^(NSArray* filteredReports, BOOL completed, NSError* error)
           {
               KSLOG_DEBUG(@"Process finished with completion: %d", completed);
               if(error != nil)
               {
                   KSLOG_ERROR(@"Failed to send reports: %@", error);
               }
               if((self.deleteBehaviorAfterSendAll == KSCDeleteOnSucess && completed) ||
                  self.deleteBehaviorAfterSendAll == KSCDeleteAlways)
               {
                   kscrash_deleteAllReports();
               }
               kscrash_callCompletion(onCompletion, filteredReports, completed, error);
           }];
      }
      

      该方法内部调用了对象方法 sendReports: onCompletion:,如下所示

      - (void) sendReports:(NSArray*) reports onCompletion:(KSCrashReportFilterCompletion) onCompletion
      {
          if([reports count] == 0)
          {
              kscrash_callCompletion(onCompletion, reports, YES, nil);
              return;
          }
          
          if(self.sink == nil)
          {
              kscrash_callCompletion(onCompletion, reports, NO,
                                       [NSError errorWithDomain:[[self class] description]
                                                           code:0
                                                    description:@"No sink set. Crash reports not sent."]);
              return;
          }
          
          [self.sink filterReports:reports
                      onCompletion:^(NSArray* filteredReports, BOOL completed, NSError* error)
           {
               kscrash_callCompletion(onCompletion, filteredReports, completed, error);
           }];
      }
      

      方法内部的 [self.sink filterReports: onCompletion: ] 实现其实就是 CMCrashInstallation 中设置的 sink getter 方法,内部返回了 CMCrashReporterSink 对象的 defaultCrashReportFilterSetAppleFmt 方法的返回值。内部实现如下

      - (id <KSCrashReportFilter>) defaultCrashReportFilterSetAppleFmt
      {
          return [KSCrashReportFilterPipeline filterWithFilters:
                  [CMCrashReportFilterAppleFmt filterWithReportStyle:KSAppleReportStyleSymbolicatedSideBySide],
                  self,
                  nil];
      }
      

      可以看到这个函数内部设置了多个 filters,其中一个就是 self,也就是 CMCrashReporterSink 对象,所以上面的 [self.sink filterReports: onCompletion:] ,也就是调用 CMCrashReporterSink 内的数据处理方法。完了之后通过 kscrash_callCompletion(onCompletion, reports, YES, nil); 告诉 KSCrash 本地保存的 Crash 日志已经处理完毕,可以删除了。

      - (void)filterReports:(NSArray *)reports onCompletion:(KSCrashReportFilterCompletion)onCompletion
      {
          for (NSDictionary *report in reports) {
              // 处理 Crash 数据,将数据交给统一的数据上报组件处理...
          }
          kscrash_callCompletion(onCompletion, reports, YES, nil);
      }
      

      至此,概括下 KSCrash 做的事情,提供各种 crash 的监控能力,在 crash 后将进程信息、基本信息、异常信息、线程信息等用 c 高效转换为 json 写入文件,App 下次启动后读取本地的 crash 文件夹中的 crash 日志,让开发者可以自定义 key、value 然后去上报日志到 APM 系统,然后删除本地 crash 文件夹中的日志。

    4. 符号化

    应用 crash 之后,系统会生成一份崩溃日志,存储在设置中,应用的运行状态、调用堆栈、所处线程等信息会记录在日志中。但是这些日志是地址,并不可读,所以需要进行符号化还原。

    4.1 .dSYM 文件

    .dSYM (debugging symbol)文件是保存十六进制函数地址映射信息的中转文件,调试信息(symbols)都包含在该文件中。Xcode 工程每次编译运行都会生成新的 .dSYM 文件。默认情况下 debug 模式时不生成 .dSYM ,可以在 Build Settings -> Build Options -> Debug Information Format 后将值 DWARF 修改为 DWARF with dSYM File,这样再次编译运行就可以生成 .dSYM 文件。

    所以每次 App 打包的时候都需要保存每个版本的 .dSYM 文件。

    .dSYM 文件中包含 DWARF 信息,打开文件的包内容 Test.app.dSYM/Contents/Resources/DWARF/Test 保存的就是 DWARF 文件。

    .dSYM 文件是从 Mach-O 文件中抽取调试信息而得到的文件目录,发布的时候为了安全,会把调试信息存储在单独的文件,.dSYM 其实是一个文件目录,结构如下:

    在这里插入图片描述

    4.2 DWARF 文件

    DWARF is a debugging file format used by many compilers and debuggers to support source level debugging. It addresses the requirements of a number of procedural languages, such as C, C++, and Fortran, and is designed to be extensible to other languages. DWARF is architecture independent and applicable to any processor or operating system. It is widely used on Unix, Linux and other operating systems, as well as in stand-alone environments.

    DWARF 是一种调试文件格式,它被许多编译器和调试器所广泛使用以支持源代码级别的调试。它满足许多过程语言(C、C++、Fortran)的需求,它被设计为支持拓展到其他语言。DWARF 是架构独立的,适用于其他任何的处理器和操作系统。被广泛使用在 Unix、Linux 和其他的操作系统上,以及独立环境上。

    DWARF 全称是 Debugging With Arbitrary Record Formats,是一种使用属性化记录格式的调试文件。

    DWARF 是可执行程序与源代码关系的一个紧凑表示。

    大多数现代编程语言都是块结构:每个实体(一个类、一个函数)被包含在另一个实体中。一个 c 程序,每个文件可能包含多个数据定义、多个变量、多个函数,所以 DWARF 遵循这个模型,也是块结构。DWARF 里基本的描述项是调试信息项 DIE(Debugging Information Entry)。一个 DIE 有一个标签,表示这个 DIE 描述了什么以及一个填入了细节并进一步描述该项的属性列表(类比 html、xml 结构)。一个 DIE(除了最顶层的)被一个父 DIE 包含,可能存在兄弟 DIE 或者子 DIE,属性可能包含各种值:常量(比如一个函数名),变量(比如一个函数的起始地址),或对另一个DIE的引用(比如一个函数的返回值类型)。

    DWARF 文件中的数据如下:

    数据列信息说明
    .debug_loc在 DW_AT_location 属性中使用的位置列表
    .debug_macinfo宏信息
    .debug_pubnames全局对象和函数的查找表
    .debug_pubtypes全局类型的查找表
    .debug_ranges在 DW_AT_ranges 属性中使用的地址范围
    .debug_str在 .debug_info 中使用的字符串表
    .debug_types类型描述

    常用的标记与属性如下:

    数据列信息说明
    DW_TAG_class_type表示类名称和类型信息
    DW_TAG_structure_type表示结构名称和类型信息
    DW_TAG_union_type表示联合名称和类型信息
    DW_TAG_enumeration_type表示枚举名称和类型信息
    DW_TAG_typedef表示 typedef 的名称和类型信息
    DW_TAG_array_type表示数组名称和类型信息
    DW_TAG_subrange_type表示数组的大小信息
    DW_TAG_inheritance表示继承的类名称和类型信息
    DW_TAG_member表示类的成员
    DW_TAG_subprogram表示函数的名称信息
    DW_TAG_formal_parameter表示函数的参数信息
    DW_TAG_name表示名称字符串
    DW_TAG_type表示类型信息
    DW_TAG_artifical在创建时由编译程序设置
    DW_TAG_sibling表示兄弟位置信息
    DW_TAG_data_memver_location表示位置信息
    DW_TAG_virtuality在虚拟时设置

    简单看一个 DWARF 的例子:将测试工程的 .dSYM 文件夹下的 DWARF 文件用下面命令解析

    dwarfdump -F --debug-info Test.app.dSYM/Contents/Resources/DWARF/Test > debug-info.txt
    

    打开如下:

    Test.app.dSYM/Contents/Resources/DWARF/Test:	file format Mach-O arm64
    
    .debug_info contents:
    0x00000000: Compile Unit: length = 0x0000004f version = 0x0004 abbr_offset = 0x0000 addr_size = 0x08 (next unit at 0x00000053)
    
    0x0000000b: DW_TAG_compile_unit
                  DW_AT_producer [DW_FORM_strp]	("Apple clang version 11.0.3 (clang-1103.0.32.62)")
                  DW_AT_language [DW_FORM_data2]	(DW_LANG_ObjC)
                  DW_AT_name [DW_FORM_strp]	("_Builtin_stddef_max_align_t")
                  DW_AT_stmt_list [DW_FORM_sec_offset]	(0x00000000)
                  DW_AT_comp_dir [DW_FORM_strp]	("/Users/lbp/Desktop/Test")
                  DW_AT_APPLE_major_runtime_vers [DW_FORM_data1]	(0x02)
                  DW_AT_GNU_dwo_id [DW_FORM_data8]	(0x392b5344d415340c)
    
    0x00000027:   DW_TAG_module
                    DW_AT_name [DW_FORM_strp]	("_Builtin_stddef_max_align_t")
                    DW_AT_LLVM_config_macros [DW_FORM_strp]	("\"-DDEBUG=1\" \"-DOBJC_OLD_DISPATCH_PROTOTYPES=1\"")
                    DW_AT_LLVM_include_path [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.3/include")
                    DW_AT_LLVM_isysroot [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk")
    
    0x00000038:     DW_TAG_typedef
                      DW_AT_type [DW_FORM_ref4]	(0x0000004b "long double")
                      DW_AT_name [DW_FORM_strp]	("max_align_t")
                      DW_AT_decl_file [DW_FORM_data1]	("/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.3/include/__stddef_max_align_t.h")
                      DW_AT_decl_line [DW_FORM_data1]	(16)
    
    0x00000043:     DW_TAG_imported_declaration
                      DW_AT_decl_file [DW_FORM_data1]	("/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.3/include/__stddef_max_align_t.h")
                      DW_AT_decl_line [DW_FORM_data1]	(27)
                      DW_AT_import [DW_FORM_ref_addr]	(0x0000000000000027)
    
    0x0000004a:     NULL
    
    0x0000004b:   DW_TAG_base_type
                    DW_AT_name [DW_FORM_strp]	("long double")
                    DW_AT_encoding [DW_FORM_data1]	(DW_ATE_float)
                    DW_AT_byte_size [DW_FORM_data1]	(0x08)
    
    0x00000052:   NULL
    0x00000053: Compile Unit: length = 0x000183dc version = 0x0004 abbr_offset = 0x0000 addr_size = 0x08 (next unit at 0x00018433)
    
    0x0000005e: DW_TAG_compile_unit
                  DW_AT_producer [DW_FORM_strp]	("Apple clang version 11.0.3 (clang-1103.0.32.62)")
                  DW_AT_language [DW_FORM_data2]	(DW_LANG_ObjC)
                  DW_AT_name [DW_FORM_strp]	("Darwin")
                  DW_AT_stmt_list [DW_FORM_sec_offset]	(0x000000a7)
                  DW_AT_comp_dir [DW_FORM_strp]	("/Users/lbp/Desktop/Test")
                  DW_AT_APPLE_major_runtime_vers [DW_FORM_data1]	(0x02)
                  DW_AT_GNU_dwo_id [DW_FORM_data8]	(0xa4a1d339379e18a5)
    
    0x0000007a:   DW_TAG_module
                    DW_AT_name [DW_FORM_strp]	("Darwin")
                    DW_AT_LLVM_config_macros [DW_FORM_strp]	("\"-DDEBUG=1\" \"-DOBJC_OLD_DISPATCH_PROTOTYPES=1\"")
                    DW_AT_LLVM_include_path [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include")
                    DW_AT_LLVM_isysroot [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk")
    
    0x0000008b:     DW_TAG_module
                      DW_AT_name [DW_FORM_strp]	("C")
                      DW_AT_LLVM_config_macros [DW_FORM_strp]	("\"-DDEBUG=1\" \"-DOBJC_OLD_DISPATCH_PROTOTYPES=1\"")
                      DW_AT_LLVM_include_path [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include")
                      DW_AT_LLVM_isysroot [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk")
    
    0x0000009c:       DW_TAG_module
                        DW_AT_name [DW_FORM_strp]	("fenv")
                        DW_AT_LLVM_config_macros [DW_FORM_strp]	("\"-DDEBUG=1\" \"-DOBJC_OLD_DISPATCH_PROTOTYPES=1\"")
                        DW_AT_LLVM_include_path [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include")
                        DW_AT_LLVM_isysroot [DW_FORM_strp]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk")
    
    0x000000ad:         DW_TAG_enumeration_type
                          DW_AT_type [DW_FORM_ref4]	(0x00017276 "unsigned int")
                          DW_AT_byte_size [DW_FORM_data1]	(0x04)
                          DW_AT_decl_file [DW_FORM_data1]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/fenv.h")
                          DW_AT_decl_line [DW_FORM_data1]	(154)
    
    0x000000b5:           DW_TAG_enumerator
                            DW_AT_name [DW_FORM_strp]	("__fpcr_trap_invalid")
                            DW_AT_const_value [DW_FORM_udata]	(256)
    
    0x000000bc:           DW_TAG_enumerator
                            DW_AT_name [DW_FORM_strp]	("__fpcr_trap_divbyzero")
                            DW_AT_const_value [DW_FORM_udata]	(512)
    
    0x000000c3:           DW_TAG_enumerator
                            DW_AT_name [DW_FORM_strp]	("__fpcr_trap_overflow")
                            DW_AT_const_value [DW_FORM_udata]	(1024)
    
    0x000000ca:           DW_TAG_enumerator
                            DW_AT_name [DW_FORM_strp]	("__fpcr_trap_underflow")
    // ......
    0x000466ee:   DW_TAG_subprogram
                    DW_AT_name [DW_FORM_strp]	("CFBridgingRetain")
                    DW_AT_decl_file [DW_FORM_data1]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/System/Library/Frameworks/Foundation.framework/Headers/NSObject.h")
                    DW_AT_decl_line [DW_FORM_data1]	(105)
                    DW_AT_prototyped [DW_FORM_flag_present]	(true)
                    DW_AT_type [DW_FORM_ref_addr]	(0x0000000000019155 "CFTypeRef")
                    DW_AT_inline [DW_FORM_data1]	(DW_INL_inlined)
    
    0x000466fa:     DW_TAG_formal_parameter
                      DW_AT_name [DW_FORM_strp]	("X")
                      DW_AT_decl_file [DW_FORM_data1]	("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/System/Library/Frameworks/Foundation.framework/Headers/NSObject.h")
                      DW_AT_decl_line [DW_FORM_data1]	(105)
                      DW_AT_type [DW_FORM_ref4]	(0x00046706 "id")
    
    0x00046705:     NULL
    
    0x00046706:   DW_TAG_typedef
                    DW_AT_type [DW_FORM_ref4]	(0x00046711 "objc_object*")
                    DW_AT_name [DW_FORM_strp]	("id")
                    DW_AT_decl_file [DW_FORM_data1]	("/Users/lbp/Desktop/Test/Test/NetworkAPM/NSURLResponse+cm_FetchStatusLineFromCFNetwork.m")
                    DW_AT_decl_line [DW_FORM_data1]	(44)
    
    0x00046711:   DW_TAG_pointer_type
                    DW_AT_type [DW_FORM_ref4]	(0x00046716 "objc_object")
    
    0x00046716:   DW_TAG_structure_type
                    DW_AT_name [DW_FORM_strp]	("objc_object")
                    DW_AT_byte_size [DW_FORM_data1]	(0x00)
    
    0x0004671c:     DW_TAG_member
                      DW_AT_name [DW_FORM_strp]	("isa")
                      DW_AT_type [DW_FORM_ref4]	(0x00046727 "objc_class*")
                      DW_AT_data_member_location [DW_FORM_data1]	(0x00)
    // ......
    

    这里就不粘贴全部内容了(太长了)。可以看到 DIE 包含了函数开始地址、结束地址、函数名、文件名、所在行数,对于给定的地址,找到函数开始地址、结束地址之间包含该抵制的 DIE,则可以还原函数名和文件名信息。

    debug_line 可以还原文件行数等信息

    dwarfdump -F --debug-line Test.app.dSYM/Contents/Resources/DWARF/Test > debug-inline.txt
    

    贴部分信息

    Test.app.dSYM/Contents/Resources/DWARF/Test:	file format Mach-O arm64
    
    .debug_line contents:
    debug_line[0x00000000]
    Line table prologue:
        total_length: 0x000000a3
             version: 4
     prologue_length: 0x0000009a
     min_inst_length: 1
    max_ops_per_inst: 1
     default_is_stmt: 1
           line_base: -5
          line_range: 14
         opcode_base: 13
    standard_opcode_lengths[DW_LNS_copy] = 0
    standard_opcode_lengths[DW_LNS_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_advance_line] = 1
    standard_opcode_lengths[DW_LNS_set_file] = 1
    standard_opcode_lengths[DW_LNS_set_column] = 1
    standard_opcode_lengths[DW_LNS_negate_stmt] = 0
    standard_opcode_lengths[DW_LNS_set_basic_block] = 0
    standard_opcode_lengths[DW_LNS_const_add_pc] = 0
    standard_opcode_lengths[DW_LNS_fixed_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_set_prologue_end] = 0
    standard_opcode_lengths[DW_LNS_set_epilogue_begin] = 0
    standard_opcode_lengths[DW_LNS_set_isa] = 1
    include_directories[  1] = "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.3/include"
    file_names[  1]:
               name: "__stddef_max_align_t.h"
          dir_index: 1
           mod_time: 0x00000000
             length: 0x00000000
    
    Address            Line   Column File   ISA Discriminator Flags
    ------------------ ------ ------ ------ --- ------------- -------------
    0x0000000000000000      1      0      1   0             0  is_stmt end_sequence
    debug_line[0x000000a7]
    Line table prologue:
        total_length: 0x0000230a
             version: 4
     prologue_length: 0x00002301
     min_inst_length: 1
    max_ops_per_inst: 1
     default_is_stmt: 1
           line_base: -5
          line_range: 14
         opcode_base: 13
    standard_opcode_lengths[DW_LNS_copy] = 0
    standard_opcode_lengths[DW_LNS_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_advance_line] = 1
    standard_opcode_lengths[DW_LNS_set_file] = 1
    standard_opcode_lengths[DW_LNS_set_column] = 1
    standard_opcode_lengths[DW_LNS_negate_stmt] = 0
    standard_opcode_lengths[DW_LNS_set_basic_block] = 0
    standard_opcode_lengths[DW_LNS_const_add_pc] = 0
    standard_opcode_lengths[DW_LNS_fixed_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_set_prologue_end] = 0
    standard_opcode_lengths[DW_LNS_set_epilogue_begin] = 0
    standard_opcode_lengths[DW_LNS_set_isa] = 1
    include_directories[  1] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include"
    include_directories[  2] = "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.3/include"
    include_directories[  3] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/sys"
    include_directories[  4] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/mach"
    include_directories[  5] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/libkern"
    include_directories[  6] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/architecture"
    include_directories[  7] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/sys/_types"
    include_directories[  8] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/_types"
    include_directories[  9] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/arm"
    include_directories[ 10] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/sys/_pthread"
    include_directories[ 11] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/mach/arm"
    include_directories[ 12] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/libkern/arm"
    include_directories[ 13] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/uuid"
    include_directories[ 14] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/netinet"
    include_directories[ 15] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/netinet6"
    include_directories[ 16] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/net"
    include_directories[ 17] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/pthread"
    include_directories[ 18] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/mach_debug"
    include_directories[ 19] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/os"
    include_directories[ 20] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/malloc"
    include_directories[ 21] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/bsm"
    include_directories[ 22] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/machine"
    include_directories[ 23] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/mach/machine"
    include_directories[ 24] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/secure"
    include_directories[ 25] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/xlocale"
    include_directories[ 26] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/arpa"
    file_names[  1]:
               name: "fenv.h"
          dir_index: 1
           mod_time: 0x00000000
             length: 0x00000000
    file_names[  2]:
               name: "stdatomic.h"
          dir_index: 2
           mod_time: 0x00000000
             length: 0x00000000
    file_names[  3]:
               name: "wait.h"
          dir_index: 3
           mod_time: 0x00000000
             length: 0x00000000
    // ......
    Address            Line   Column File   ISA Discriminator Flags
    ------------------ ------ ------ ------ --- ------------- -------------
    0x000000010000b588     14      0      2   0             0  is_stmt
    0x000000010000b5b4     16      5      2   0             0  is_stmt prologue_end
    0x000000010000b5d0     17     11      2   0             0  is_stmt
    0x000000010000b5d4      0      0      2   0             0 
    0x000000010000b5d8     17      5      2   0             0 
    0x000000010000b5dc     17     11      2   0             0 
    0x000000010000b5e8     18      1      2   0             0  is_stmt
    0x000000010000b608     20      0      2   0             0  is_stmt
    0x000000010000b61c     22      5      2   0             0  is_stmt prologue_end
    0x000000010000b628     23      5      2   0             0  is_stmt
    0x000000010000b644     24      1      2   0             0  is_stmt
    0x000000010000b650     15      0      1   0             0  is_stmt
    0x000000010000b65c     15     41      1   0             0  is_stmt prologue_end
    0x000000010000b66c     11      0      2   0             0  is_stmt
    0x000000010000b680     11     17      2   0             0  is_stmt prologue_end
    0x000000010000b6a4     11     17      2   0             0  is_stmt end_sequence
    debug_line[0x0000def9]
    Line table prologue:
        total_length: 0x0000015a
             version: 4
     prologue_length: 0x000000eb
     min_inst_length: 1
    max_ops_per_inst: 1
     default_is_stmt: 1
           line_base: -5
          line_range: 14
         opcode_base: 13
    standard_opcode_lengths[DW_LNS_copy] = 0
    standard_opcode_lengths[DW_LNS_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_advance_line] = 1
    standard_opcode_lengths[DW_LNS_set_file] = 1
    standard_opcode_lengths[DW_LNS_set_column] = 1
    standard_opcode_lengths[DW_LNS_negate_stmt] = 0
    standard_opcode_lengths[DW_LNS_set_basic_block] = 0
    standard_opcode_lengths[DW_LNS_const_add_pc] = 0
    standard_opcode_lengths[DW_LNS_fixed_advance_pc] = 1
    standard_opcode_lengths[DW_LNS_set_prologue_end] = 0
    standard_opcode_lengths[DW_LNS_set_epilogue_begin] = 0
    standard_opcode_lengths[DW_LNS_set_isa] = 1
    include_directories[  1] = "Test"
    include_directories[  2] = "Test/NetworkAPM"
    include_directories[  3] = "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS13.5.sdk/usr/include/objc"
    file_names[  1]:
               name: "AppDelegate.h"
          dir_index: 1
           mod_time: 0x00000000
             length: 0x00000000
    file_names[  2]:
               name: "JMWebResourceURLProtocol.h"
          dir_index: 2
           mod_time: 0x00000000
             length: 0x00000000
    file_names[  3]:
               name: "AppDelegate.m"
          dir_index: 1
           mod_time: 0x00000000
             length: 0x00000000
    file_names[  4]:
               name: "objc.h"
          dir_index: 3
           mod_time: 0x00000000
             length: 0x00000000
    // ......
    

    可以看到 debug_line 里包含了每个代码地址对应的行数。上面贴了 AppDelegate 的部分。

    4.3 symbols

    在链接中,我们将函数和变量统称为符合(Symbol),函数名或变量名就是符号名(Symbol Name),我们可以将符号看成是链接中的粘合剂,整个链接过程正是基于符号才能正确完成的。

    上述文字来自《程序员的自我修养》。所以符号就是函数、变量、类的统称。

    按照类型划分,符号可以分为三类:

    • 全局符号:目标文件外可见的符号,可以被其他目标文件所引用,或者需要其他目标文件定义
    • 局部符号:只在目标文件内可见的符号,指只在目标文件内可见的函数和变量
    • 调试符号:包括行号信息的调试符号信息,行号信息记录了函数和变量对应的文件和文件行号。

    符号表(Symbol Table):是内存地址与函数名、文件名、行号的映射表。每个定义的符号都有一个对应的值得,叫做符号值(Symbol Value),对于变量和函数来说,符号值就是地址,符号表组成如下

    <起始地址> <结束地址> <函数> [<文件名:行号>]
    

    4.4 如何获取地址?

    image 加载的时候会进行相对基地址进行重定位,并且每次加载的基地址都不一样,函数栈 frame 的地址是重定位后的绝对地址,我们要的是重定位前的相对地址。

    Binary Images

    拿测试工程的 crash 日志举例子,打开贴部分 Binary Images 内容

    // ...
    Binary Images:
    0x102fe0000 - 0x102ff3fff Test arm64  <37eaa57df2523d95969e47a9a1d69ce5> /var/containers/Bundle/Application/643F0DFE-A710-4136-A278-A89D780B7208/Test.app/Test
    0x1030e0000 - 0x1030ebfff libobjc-trampolines.dylib arm64  <181f3aa866d93165ac54344385ac6e1d> /usr/lib/libobjc-trampolines.dylib
    0x103204000 - 0x103267fff dyld arm64  <6f1c86b640a3352a8529bca213946dd5> /usr/lib/dyld
    0x189a78000 - 0x189a8efff libsystem_trace.dylib arm64  <b7477df8f6ab3b2b9275ad23c6cc0b75> /usr/lib/system/libsystem_trace.dylib
    // ...
    

    可以看到 Crash 日志的 Binary Images 包含每个 Image 的加载开始地址、结束地址、image 名称、arm 架构、uuid、image 路径。

    crash 日志中的信息

    Last Exception Backtrace:
    // ...
    5   Test                          	0x102fe592c -[ViewController testMonitorCrash] + 22828 (ViewController.mm:58)
    
    Binary Images:
    0x102fe0000 - 0x102ff3fff Test arm64  <37eaa57df2523d95969e47a9a1d69ce5> /var/containers/Bundle/Application/643F0DFE-A710-4136-A278-A89D780B7208/Test.app/Test
    

    所以 frame 5 的相对地址为 0x102fe592c - 0x102fe0000。再使用 命令可以还原符号信息。

    使用 atos 来解析,0x102fe0000 为 image 加载的开始地址,0x102fe592c 为 frame 需要还原的地址。

    atos -o Test.app.dSYM/Contents/Resources/DWARF/Test-arch arm64 -l 0x102fe0000 0x102fe592c
    

    4.5 UUID

    • crash 文件的 UUID

      grep --after-context=2 "Binary Images:" *.crash
      
      Test  5-28-20, 7-47 PM.crash:Binary Images:
      Test  5-28-20, 7-47 PM.crash-0x102fe0000 - 0x102ff3fff Test arm64  <37eaa57df2523d95969e47a9a1d69ce5> /var/containers/Bundle/Application/643F0DFE-A710-4136-A278-A89D780B7208/Test.app/Test
      Test  5-28-20, 7-47 PM.crash-0x1030e0000 - 0x1030ebfff libobjc-trampolines.dylib arm64  <181f3aa866d93165ac54344385ac6e1d> /usr/lib/libobjc-trampolines.dylib
      --
      Test.crash:Binary Images:
      Test.crash-0x102fe0000 - 0x102ff3fff Test arm64  <37eaa57df2523d95969e47a9a1d69ce5> /var/containers/Bundle/Application/643F0DFE-A710-4136-A278-A89D780B7208/Test.app/Test
      Test.crash-0x1030e0000 - 0x1030ebfff libobjc-trampolines.dylib arm64  <181f3aa866d93165ac54344385ac6e1d> /usr/lib/libobjc-trampolines.dylib
      

      Test App 的 UUID 为 37eaa57df2523d95969e47a9a1d69ce5.

    • .dSYM 文件的 UUID

      dwarfdump --uuid Test.app.dSYM
      

      结果为

      UUID: 37EAA57D-F252-3D95-969E-47A9A1D69CE5 (arm64) Test.app.dSYM/Contents/Resources/DWARF/Test
      
    • app 的 UUID

      dwarfdump --uuid Test.app/Test
      

      结果为

      UUID: 37EAA57D-F252-3D95-969E-47A9A1D69CE5 (arm64) Test.app/Test
      

    4.6 符号化(解析 Crash 日志)

    上述篇幅分析了如何捕获各种类型的 crash,App 在用户手中我们通过技术手段可以获取 crash 案发现场信息并结合一定的机制去上报,但是这种堆栈是十六进制的地址,无法定位问题,所以需要做符号化处理。

    上面也说明了.dSYM 文件 的作用,通过符号地址结合 dSYM 文件来还原文件名、所在行、函数名,这个过程叫符号化。但是 .dSYM 文件必须和 crash log 文件的 bundle id、version 严格对应。

    获取 Crash 日志可以通过 Xcode -> Window -> Devices and Simulators 选择对应设备,找到 Crash 日志文件,根据时间和 App 名称定位。

    app 和 .dSYM 文件可以通过打包的产物得到,路径为 ~/Library/Developer/Xcode/Archives

    解析方法一般有2种:

    • 使用 symbolicatecrash

      symbolicatecrash 是 Xcode 自带的 crash 日志分析工具,先确定所在路径,在终端执行下面的命令

      find /Applications/Xcode.app -name symbolicatecrash -type f
      

      会返回几个路径,找到 iPhoneSimulator.platform 所在那一行

      /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/Library/PrivateFrameworks/DVTFoundation.framework/symbolicatecrash
      

      将 symbolicatecrash 拷贝到指定文件夹下(保存了 app、dSYM、crash 文件的文件夹)

      执行命令

      ./symbolicatecrash Test.crash Test.dSYM > Test.crash
      

      第一次做这事儿应该会报错 Error: "DEVELOPER_DIR" is not defined at ./symbolicatecrash line 69.,解决方案:在终端执行下面命令

      export DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer
      
    • 使用 atos

      区别于 symbolicatecrash,atos 较为灵活,只要 .crash.dSYM 或者 .crash.app 文件对应即可。

      用法如下,-l 最后跟得是符号地址

      xcrun atos -o Test.app.dSYM/Contents/Resources/DWARF/Test -arch armv7 -l 0x1023c592c
      

      也可以解析 .app 文件(不存在 .dSYM 文件),其中xxx为段地址,xx为偏移地址

      atos -arch architecture -o binary -l xxx xx
      

    因为我们的 App 可能有很多,每个 App 在用户手中可能是不同的版本,所以在 APM 拦截之后需要符号化的时候需要将 crash 文件和 .dSYM 文件一一对应,才能正确符号化,对应的原则就是 UUID 一致。

    4.7 系统库符号化解析

    我们每次真机连接 Xcode 运行程序,会提示等待,其实系统为了堆栈解析,都会把当前版本的系统符号库自动导入到 /Users/你自己的用户名/Library/Developer/Xcode/iOS DeviceSupport 目录下安装了一大堆系统库的符号化文件。你可以访问下面目录看看

    /Users/你自己的用户名/Library/Developer/Xcode/iOS DeviceSupport/
    

    在这里插入图片描述

    5. 服务端处理

    5.1 ELK 日志系统

    业界设计日志监控系统一般会采用基于 ELK 技术。ELK 是 Elasticsearch、Logstash、Kibana 三个开源框架缩写。Elasticsearch 是一个分布式、通过 Restful 方式进行交互的近实时搜索的平台框架。Logstash 是一个中央数据流引擎,用于从不同目标(文件/数据存储/MQ)收集不同格式的数据,经过过滤后支持输出到不同目的地(文件/MQ/Redis/ElasticsSearch/Kafka)。Kibana 可以将 Elasticserarch 的数据通过友好的页面展示出来,提供可视化分析功能。所以 ELK 可以搭建一个高效、企业级的日志分析系统。

    早期单体应用时代,几乎应用的所有功能都在一台机器上运行,出了问题,运维人员打开终端输入命令直接查看系统日志,进而定位问题、解决问题。随着系统的功能越来越复杂,用户体量越来越大,单体应用几乎很难满足需求,所以技术架构迭代了,通过水平拓展来支持庞大的用户量,将单体应用进行拆分为多个应用,每个应用采用集群方式部署,负载均衡控制调度,假如某个子模块发生问题,去找这台服务器上终端找日志分析吗?显然台落后,所以日志管理平台便应运而生。通过 Logstash 去收集分析每台服务器的日志文件,然后按照定义的正则模版过滤后传输到 Kafka 或 Redis,然后由另一个 Logstash 从 Kafka 或 Redis 上读取日志存储到 ES 中创建索引,最后通过 Kibana 进行可视化分析。此外可以将收集到的数据进行数据分析,做更进一步的维护和决策。

    在这里插入图片描述

    上图展示了一个 ELK 的日志架构图。简单说明下:

    • Logstash 和 ES 之前存在一个 Kafka 层,因为 Logstash 是架设在数据资源服务器上,将收集到的数据进行实时过滤,过滤需要消耗时间和内存,所以存在 Kafka,起到了数据缓冲存储作用,因为 Kafka 具备非常出色的读写性能。
    • 再一步就是 Logstash 从 Kafka 里面进行读取数据,将数据过滤、处理,将结果传输到 ES
    • 这个设计不但性能好、耦合低,还具备可拓展性。比如可以从 n 个不同的 Logstash 上读取传输到 n 个 Kafka 上,再由 n 个 Logstash 过滤处理。日志来源可以是 m 个,比如 App 日志、Tomcat 日志、Nginx 日志等等

    下图贴一个 Elasticsearch 社区分享的一个 “Elastic APM 动手实战”主题的内容截图。

    在这里插入图片描述

    5.2 服务侧

    Crash log 统一入库 Kibana 时是没有符号化的,所以需要符号化处理,以方便定位问题、crash 产生报表和后续处理。

    在这里插入图片描述

    所以整个流程就是:客户端 APM SDK 收集 crash log -> Kafka 存储 -> Mac 机执行定时任务符号化 -> 数据回传 Kafka -> 产品侧(显示端)对数据进行分类、报表、报警等操作。

    因为公司的产品线有多条,相应的 App 有多个,用户使用的 App 版本也各不相同,所以 crash 日志分析必须要有正确的 .dSYM 文件,那么多 App 的不同版本,自动化就变得非常重要了。

    自动化有2种手段,规模小一点的公司或者图省事,可以在 Xcode中 添加 runScript 脚本代码来自动在 release 模式下上传dSYM)。

    因为我们公司有自己的一套体系,wax-cli,可以同时管理 iOS SDK、iOS App、Android SDK、Android App、Node、React、React Native 工程项目的初始化、依赖管理、构建(持续集成、Unit Test、Lint、统跳检测)、测试、打包、部署、动态能力(热更新、统跳路由下发)等能力于一身。可以基于各个阶段做能力的插入,所以可以在调用打包后在打包机上传 .dSYM 文件到七牛云存储(规则可以是以 AppName + Version 为 key,value 为 .dSYM 文件)。

    现在很多架构设计都是微服务,至于为什么选微服务,不在本文范畴。所以 crash 日志的符号化被设计为一个微服务。架构图如下:

    在这里插入图片描述

    说明:

    • Symbolication Service 作为整个监控系统 Prism 的一个组成部分,是专注于 crash report 符号化的微服务。

    • 接收来自 mass 的包含预处理过的 crash report 和 dsym index 的请求,从七牛拉取对应的 dsym,对 crash report 做符号化解析,计算 hash,并将 hash 响应给 mass。

    • 接收来自 Prism 管理系统的包含原始 crash report 和 dsym index 的请求,从七牛拉取对应的 dsym,对crash report 做符号化解析,并将符号化的 crash report 响应给 Prism 管理系统。

    • Mass 是一个通用的数据处理(流式/批式)和任务调度框架

    • candle 是一个打包系统,上面说的 wax-cli 有个能力就是打包,其实就是调用的 candle 系统的打包构建能力。会根据项目的特点,选择合适的打包机(打包平台是维护了多个打包任务,不同任务根据特点被派发到不同的打包机上,任务详情页可以看到依赖的下载、编译、运行过程等,打包好的产物包括二进制包、下载二维码等等)

    在这里插入图片描述

    其中符号化服务是大前端背景下大前端团队的产物,所以是 NodeJS 实现的。iOS 的符号化机器是 双核的 Mac mini,这就需要做实验测评到底需要开启几个 worker 进程做符号化服务。结果是双进程处理 crash log,比单进程效率高近一倍,而四进程比双进程效率提升不明显,符合双核 mac mini 的特点。所以开启两个 worker 进程做符号化处理。

    下图是完整设计图:

    在这里插入图片描述

    简单说明下,符号化流程是一个主从模式,一台 master 机,多个 slave 机,master 机读取 .dSYM 和 crash 结果的 cache。mass 调度符号化服务(内部2个 symbolocate worker)同时从七牛云上获取 .dSYM 文件。

    系统架构图如下:

    在这里插入图片描述

    八、 APM 小结

    1. 通常来说各个端的监控能力是不太一致的,技术实现细节也不统一。所以在技术方案评审的时候需要将监控能力对齐统一。每个能力在各个端的数据字段必须对齐(字段个数、名称、数据类型和精度),因为 APM 本身是一个闭环,监控了之后需符号化解析、数据整理,进行产品化开发、最后需要监控大盘展示等

    2. 一些 crash 或者 ANR 等根据等级需要邮件、短信、企业内容通信工具告知干系人,之后快速发布版本、hot fix 等。

    3. 监控的各个能力需要做成可配置,灵活开启关闭。

    4. 监控数据需要做内存到文件的写入处理,需要注意策略。监控数据需要存储数据库,数据库大小、设计规则等。存入数据库后如何上报,上报机制等会在另一篇文章讲:打造一个通用、可配置的数据上报 SDK

    5. 尽量在技术评审后,将各端的技术实现写进文档中,同步给相关人员。比如 ANR 的实现

      /*
      android 端
      
      根据设备分级,一般超过 300ms 视为一次卡顿
      hook 系统 loop,在消息处理前后插桩,用以计算每条消息的时长
      开启另外线程 dump 堆栈,处理结束后关闭
      */
      new ExceptionProcessor().init(this, new Runnable() {
                  @Override
                  public void run() {
                      //监测卡顿
                      try {
                          ProxyPrinter proxyPrinter = new ProxyPrinter(PerformanceMonitor.this);
                          Looper.getMainLooper().setMessageLogging(proxyPrinter);
                          mWeakPrinter = new WeakReference<ProxyPrinter>(proxyPrinter);
                      } catch (FileNotFoundException e) {
                      }
                  }
              })
              
      /*
      iOS 端
      
      子线程通过 ping 主线程来确认主线程当前是否卡顿。
      卡顿阈值设置为 300ms,超过阈值时认为卡顿。
      卡顿时获取主线程的堆栈,并存储上传。
      */ 
      - (void) main() {
          while (self.cancle == NO) {
              self.isMainThreadBlocked = YES;
              dispatch_async(dispatch_get_main_queue(), ^{
                  self.isMainThreadBlocked = YES;
                  [self.semaphore singal];
              });
              [Thread sleep:300];
              if (self.isMainThreadBlocked) {
                  [self handleMainThreadBlock];
              }
              [self.semaphore wait];
          }
      }
      
    6. 整个 APM 的架构图如下

    在这里插入图片描述

    说明:

    • 埋点 SDK,通过 sessionId 来关联日志数据
    • wax 上面介绍过了,是一种多端项目管理模式,每个 wax 项目都具有基础信息
    1. APM 技术方案本身是随着技术手段、分析需求不断调整升级的。上图的几个结构示意图是早期几个版本的,目前使用的是在此基础上进行了升级和结构调整,提几个关键词:Hermes、Flink SQL、InfluxDB。

    参考资料

    展开全文
  • 通过Dockerfile可以用来构建容器镜像,我们一般也是通过这种方式来构建一个Tomcat应用服务容器,如果要实现对容器中的Tomcat服务(或是其他Java应用)进行APM(应用性能管理)监控,就需要我们在容器中放置javaagent...
  • iOS APM监控总览

    千次阅读 2020-06-29 10:35:08
    APP APM考察指标主要包含卡顿、网络、crash、耗电量、CPU使用率、内存消耗等几个方面
  • 影响着用户的直接体验,所以针对 App 的卡顿监控APM 里面重要的一环。 FPS(frame per second)每秒钟的帧刷新次数,iPhone 手机以 60 为最佳,iPad 某些型号是 120,也是作为卡顿监控的一项参考参数,为什么说是...
  • Pinpoint- APM监控平台搭建

    千次阅读 2018-08-07 16:14:24
    pinpoint是开源在github上的一款APM监控工具,它是用Java编写的,用于大规模分布式系统监控。它对性能的影响最小(只增加约3%资源利用率),安装agent是无侵入式的,只需要在被测试的Tomcat中加上3句话,打下探针,...
  • 五、 App 网络监控 移动网络环境一直很复杂,WIFI、2G、3G、4G、5G 等,用户使用 App 的过程中可能在这几种类型之间切换,这也是移动网络和传统网络间的一个区别,被称为「Connection Migration」。此外还存在 DNS ...
  • APM与其它对比2.1 Zipkin2.2 Pinpoint2.3 Skywalking3. Server安装部署4. Agent安装4.1 拷贝agent 4.2 修改配置4.3 添加trace-ignore插件4.4 安装agent 5. 日志信息清理5.1 ES索引数据清理5.2 oap-server的log文件...
  • 现在,您可以部署您的应用程序,它将把信息发送到Monti APM。 等待一分钟,您会看到数据出现在Monti APM仪表板中。 兼容性 montiapm:agent与以下设备兼容: 流星1.4及更高版本 Internet Explorer 9和更新的Web...
  • NPM-APM监控平台竞争分析.pptx
  • Elastic添加APM监控

    千次阅读 2021-04-07 18:29:44
    Elastic添加APM监控1. 下载安装2. 配置3. 启动设置4. 查看监控 APM (Application Performance Management) 即应用性能管理,属于IT运维管理(ITOM)范畴。主要是针对企业 关键业务的IT应用性能和用户体验的监测、...
  • APM监控Pinpoint( 以集成springboot项目为例 )-搭建hadoop单机版+hbase单机版+pinpoint整合springboot-附件资源
  • APM监控--(三)zipkin部署手册

    千次阅读 2018-03-27 15:58:58
    zipkin为分布式链路调用监控系统,聚合各业务系统调用延迟数据,达到链路调用监控跟踪; zipkin通过采集跟踪数据可以帮助开发者深入了解在分布式系统中某一个特定的请求时如何执行的; 假如我们现在有一个用户请求...
  •  pinpoint是开源在github上的一款APM监控工具,它是用Java编写的,用于大规模分布式系统监控。它对性能的影响最小(只增加约3%资源利用率),安装agent是无侵入式的。 实现  通过JavaAgent的机制来做字节码代码...
  • Pinpoint是一款全链路分析工具,提供了无侵入式的调用链监控、方法执行详情查看、应用状态信息监控等功能。基于GoogleDapper论文进行的实现,与另一款开源的全链路分析工具Zipkin类似,但相比Zipkin提供了无侵入式、...
  • APM性能监控

    万次阅读 2020-11-26 22:36:45
    Monitoring (应用性能管理/监控) 性能问题是导致 App 用户流失的罪魁祸首之一,如果用户在使用我们 App 的时候遇到诸如页面卡顿、响应速度慢、发热严重、流量电量消耗大等问题的时候,很可能就会卸载掉我们的 Ap.
  • 微服务下的APM全链路监控微服务下的APM全链路监控微服务下的APM全链路监控微服务下的APM全链路监控
  • 几种分布式调用链监控组件的比较微服务架构下,服务按照不同的维度进行拆分,一次请求请求往往需要涉及到多个服务。互联网应用构建在不同的软件模块集上,这些软件模块,有可能是由不同的团队开发、可能使用不同的...
  • RUN tar -zxvf apache-skywalking-apm-6.2.0.tar.gz && \ mv apache-skywalking-apm-bin skywalking && \ echo "tail -f /dev/null" >> /app/skywalking/bin/startup.sh CMD ["/bin/sh","-c","/app/skywalking/...
  • APM系统监控技术选型

    千次阅读 2019-07-11 15:12:28
    APM技术选型对比 1.概览 Pinpoint SkyWalking Zipkin(Spring cloud 整合) Jaeger 所属公司/组织 韩国 Apache Twitter Uber 组件 collector+Web+ agent+存储 OAP+Web+ agent+存储+zk Collector+Web+ Api...
  • https://blog.csdn.net/qq_24033577/article/details/106965268 https://blog.csdn.net/qq_24033577/article/details/106978598https://blog.csdn.net/qq_24033577/article/details/107159565
  • 目前apm监控一般都遵循Google公司发布的Dapper规范,特转载一篇,供广大网友交流概述当代的互联网的服务,通常都是用复杂的、大规模分布式集群来实现的。互联网应用构建在不同的软件模块集上,这些软件模块,有可能...
  • APM 监控方法拦截器

    千次阅读 2017-01-19 09:37:53
    基础方法拦截APM内置的方法拦截器是com.navercorp.apm .bootstrap.interceptor.BasicMethodInterceptor这个拦截器不能在RPC边界的方法中使用,例如http client, http server。 这个拦截器的作用是在已有的Span中...
  • 之前在《Spring Cloud Sleuth:分布式请求链路跟踪》一文中使用的是Sleuth+Zipkin的解决方案,最近发现应用性能监控(Application Performance Monitoring,APM)也可以很好地解决该问题。对比SkyWalking和Elastic ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 9,863
精华内容 3,945
关键字:

apm监控