騰訊 Apm 框架 Matrix 源碼閱讀 - TracePlugin 之 AnrTracer

版本

v0.6.5

溫馨提示

  1. 在讀這篇文章之前墻裂建議先讀騰訊 Apm 框架 Matrix 源碼閱讀 - TracePlugin 架構(gòu)解析
  2. TracePlugin 是比較復(fù)雜的，很多東西文章中可能講的不是很清楚，配合 推薦 Matrix 源碼完整注釋
    可能會(huì)有更好的效果

概述

本篇文章是 騰訊開源的 APM 框架 Matrix 系列文章的第四篇，將對(duì)matrix-trace-canary這個(gè)模塊種的StartupTracer類進(jìn)行解析。這個(gè)類主要監(jiān)控并上報(bào)App 冷/暖啟動(dòng)時(shí)間，Activity啟動(dòng)時(shí)間。上一篇為騰訊 Apm 框架 Matrix 源碼閱讀 - TracePlugin 之 StartupTracer

原理簡(jiǎn)介

通過 UIThreadMonitor 感知Looper loop工作的開始，刷新幀，結(jié)束的時(shí)間，并在結(jié)束時(shí)分析是否超過閾值，如果超過就從AppMethodBeat中獲取相關(guān)數(shù)據(jù)進(jìn)行分析并上報(bào)。

1. AnrTracer.生命周期方法

    public AnrTracer(TraceConfig traceConfig) {
        this.traceConfig = traceConfig;
        this.isAnrTraceEnable = traceConfig.isAnrTraceEnable();
    }

    @Override
    public void onAlive() {
        super.onAlive();
        if (isAnrTraceEnable) {
            //添加 LooperObserver 監(jiān)聽 詳見【1.1】
            UIThreadMonitor.getMonitor().addObserver(this);
            //子線程handler
            this.anrHandler = new Handler(MatrixHandlerThread.getDefaultHandler().getLooper());
        }
    }

    @Override
    public void onDead() {
        super.onDead();
        if (isAnrTraceEnable) {
            //移除 LooperObserver 監(jiān)聽
            UIThreadMonitor.getMonitor().removeObserver(this);
            if (null != anrTask) {
                //釋放 BeginRecord
                anrTask.getBeginRecord().release();
            }
            //anrHandler移除所有消息并退出
            anrHandler.removeCallbacksAndMessages(null);
            anrHandler.getLooper().quit();
        }
    }

首先構(gòu)造方法也是讀取配置并記錄起來，onAlive()方法注冊(cè)了LooperObserver監(jiān)聽，初始化了子線程handler anrHandler，onDead()中移除 LooperObserver 監(jiān)聽，清空anrHandler消息并退出

1.1 AnrTracer.dispatchBegin

AnrTracer注冊(cè)了 LooperObserver 監(jiān)聽 所以會(huì)分別回調(diào)它里面的 dispatchBegin,doFrame,dispatchEnd方法，因?yàn)?code>AnrTracer.doFrame并沒有什么實(shí)質(zhì)性的作用所以下面我們就對(duì)dispatchBegin,dispatchEnd這兩個(gè)方法進(jìn)行分析。

    public void dispatchBegin(long beginMs, long cpuBeginMs, long token) {
        super.dispatchBegin(beginMs, cpuBeginMs, token);
        //創(chuàng)建 AnrHandleTask
        anrTask = new AnrHandleTask(AppMethodBeat.getInstance().maskIndex("AnrTracer#dispatchBegin"), token);
        if (traceConfig.isDevEnv()) {
            MatrixLog.v(TAG, "* [dispatchBegin] token:%s index:%s", token, anrTask.beginRecord.index);
        }
        //將anrTask加入到anrHandler的延時(shí)隊(duì)列中，如果超過5s anrTask還沒有被移除就會(huì)被執(zhí)行
        anrHandler.postDelayed(anrTask, Constants.DEFAULT_ANR - (SystemClock.uptimeMillis() - token));
    }

該方法主要作用是 創(chuàng)建anrTask并加入到anrHandler的延時(shí)隊(duì)列中

1.2 AnrTracer.dispatchEnd

     public void dispatchEnd(long beginMs, long cpuBeginMs, long endMs, long cpuEndMs, long token, boolean isBelongFrame) {
        super.dispatchEnd(beginMs, cpuBeginMs, endMs, cpuEndMs, token, isBelongFrame);
        if (traceConfig.isDevEnv()) {
            MatrixLog.v(TAG, "[dispatchEnd] token:%s cost:%sms cpu:%sms usage:%s",
                    token, endMs - beginMs, cpuEndMs - cpuBeginMs, Utils.calculateCpuUsage(cpuEndMs - cpuBeginMs, endMs - beginMs));
        }
        if (null != anrTask) {
            //將anrTask從anrHandler的延時(shí)隊(duì)列中移除
            anrTask.getBeginRecord().release();
            anrHandler.removeCallbacks(anrTask);
        }
    }

這個(gè)方法就是將anrTask從延時(shí)隊(duì)列中移除。如果及時(shí)移除了就不會(huì)進(jìn)行任何操作，如果超過5s還沒有移除就會(huì)被Matrix判定為自定義的ANR，這個(gè)時(shí)候就會(huì)走到anrTask.run方法。

1.3 AnrHandleTask.run

  public void run() {
            //當(dāng)前時(shí)間
            long curTime = SystemClock.uptimeMillis();
            //app 是否處于前臺(tái)
            boolean isForeground = isForeground();
            // process 優(yōu)先級(jí)
            int[] processStat = Utils.getProcessPriority(Process.myPid());
            //獲取需要分析的方法棧信息
            long[] data = AppMethodBeat.getInstance().copyData(beginRecord);
            //釋放 beginRecord
            beginRecord.release();
            //當(dāng)前可見activity
            String scene = AppMethodBeat.getVisibleScene();

            // memory
            long[] memoryInfo = dumpMemory();

            // 線程狀態(tài)
            Thread.State status = Looper.getMainLooper().getThread().getState();
            //堆棧信息
            StackTraceElement[] stackTrace = Looper.getMainLooper().getThread().getStackTrace();
            String dumpStack = Utils.getStack(stackTrace, "|*\t\t", 12);

            // 通過token（dispatchStart時(shí)間）獲取不同Type 的耗費(fèi)時(shí)間
            UIThreadMonitor monitor = UIThreadMonitor.getMonitor();
            long inputCost = monitor.getQueueCost(UIThreadMonitor.CALLBACK_INPUT, token);
            long animationCost = monitor.getQueueCost(UIThreadMonitor.CALLBACK_ANIMATION, token);
            long traversalCost = monitor.getQueueCost(UIThreadMonitor.CALLBACK_TRAVERSAL, token);

            // trace
            LinkedList<MethodItem> stack = new LinkedList();
            if (data.length > 0) {
                // 根據(jù)之前 data 查到的 methodId ，拿到對(duì)應(yīng)插樁函數(shù)的執(zhí)行時(shí)間、執(zhí)行深度，將每個(gè)函數(shù)的信息封裝成 MethodItem，然后存儲(chǔ)到 stack 鏈表當(dāng)中
                TraceDataUtils.structuredDataToStack(data, stack, true, curTime);
                //根據(jù)規(guī)則 裁剪 stack 中的數(shù)據(jù)，
                TraceDataUtils.trimStack(stack, Constants.TARGET_EVIL_METHOD_STACK, new TraceDataUtils.IStructuredDataFilter() {
                    @Override
                    public boolean isFilter(long during, int filterCount) {
                        return during < filterCount * Constants.TIME_UPDATE_CYCLE_MS;
                    }

                    @Override
                    public int getFilterMaxCount() {
                        return Constants.FILTER_STACK_MAX_COUNT;
                    }

                    @Override
                    public void fallback(List<MethodItem> stack, int size) {
                        MatrixLog.w(TAG, "[fallback] size:%s targetSize:%s stack:%s", size, Constants.TARGET_EVIL_METHOD_STACK, stack);
                        Iterator iterator = stack.listIterator(Math.min(size, Constants.TARGET_EVIL_METHOD_STACK));
                        while (iterator.hasNext()) {
                            iterator.next();
                            iterator.remove();
                        }
                    }
                });
            }

            StringBuilder reportBuilder = new StringBuilder();
            StringBuilder logcatBuilder = new StringBuilder();
            //獲取最大的耗時(shí)時(shí)間
            long stackCost = Math.max(Constants.DEFAULT_ANR, TraceDataUtils.stackToString(stack, reportBuilder, logcatBuilder));

            // 查詢出最耗時(shí)的 方法id
            String stackKey = TraceDataUtils.getTreeKey(stack, stackCost);
            MatrixLog.w(TAG, "%s \npostTime:%s curTime:%s",
                    printAnr(scene, processStat, memoryInfo, status, logcatBuilder, isForeground, stack.size(),
                            stackKey, dumpStack, inputCost, animationCost, traversalCost, stackCost), token, curTime); // for logcat

            //異常情況判斷（當(dāng) AnrHandleTask 沒有及時(shí)執(zhí)行時(shí)會(huì)發(fā)生）
            if (stackCost >= Constants.DEFAULT_ANR_INVALID) {
                MatrixLog.w(TAG, "The checked anr task was not executed on time. "
                        + "The possible reason is that the current process has a low priority. just pass this report");
                return;
            }
            // report
            try {
                TracePlugin plugin = Matrix.with().getPluginByClass(TracePlugin.class);
                if (null == plugin) {
                    return;
                }
                JSONObject jsonObject = new JSONObject();
                jsonObject = DeviceUtil.getDeviceInfo(jsonObject, Matrix.with().getApplication());
                jsonObject.put(SharePluginInfo.ISSUE_STACK_TYPE, Constants.Type.ANR);
                jsonObject.put(SharePluginInfo.ISSUE_COST, stackCost);
                jsonObject.put(SharePluginInfo.ISSUE_STACK_KEY, stackKey);
                jsonObject.put(SharePluginInfo.ISSUE_SCENE, scene);
                jsonObject.put(SharePluginInfo.ISSUE_TRACE_STACK, reportBuilder.toString());
                jsonObject.put(SharePluginInfo.ISSUE_THREAD_STACK, Utils.getStack(stackTrace));
                jsonObject.put(SharePluginInfo.ISSUE_PROCESS_PRIORITY, processStat[0]);
                jsonObject.put(SharePluginInfo.ISSUE_PROCESS_NICE, processStat[1]);
                jsonObject.put(SharePluginInfo.ISSUE_PROCESS_FOREGROUND, isForeground);
                // memory info
                JSONObject memJsonObject = new JSONObject();
                memJsonObject.put(SharePluginInfo.ISSUE_MEMORY_DALVIK, memoryInfo[0]);
                memJsonObject.put(SharePluginInfo.ISSUE_MEMORY_NATIVE, memoryInfo[1]);
                memJsonObject.put(SharePluginInfo.ISSUE_MEMORY_VM_SIZE, memoryInfo[2]);
                jsonObject.put(SharePluginInfo.ISSUE_MEMORY, memJsonObject);

                Issue issue = new Issue();
                issue.setKey(token + "");
                issue.setTag(SharePluginInfo.TAG_PLUGIN_EVIL_METHOD);
                issue.setContent(jsonObject);
                plugin.onDetectIssue(issue);

            } catch (JSONException e) {
                MatrixLog.e(TAG, "[JSONException error: %s", e);
            }

        }

這個(gè)方法就完成了從AppMethodBeat中獲取數(shù)據(jù)在進(jìn)行整理，裁剪，組建長(zhǎng)json后進(jìn)行上報(bào)的工作。

AnrTracer 上報(bào)數(shù)據(jù)解析

tag: Trace_EvilMethod
key：token(dispatchStart的時(shí)間)

detail：固定為ANR
cost：總耗時(shí)
usage：主線程cpu占用率
scene：當(dāng)前可見Activity名稱
stack：方法棧信息， 每個(gè)item之間用“\n”隔開，每個(gè)item的含義為，調(diào)用深度，methodId，調(diào)用次數(shù)，耗時(shí)
    * 比如：0,118,1,5 -> 調(diào)用深度為0，methodId=118，調(diào)用次數(shù)=1，耗時(shí)5ms
stackKey：主要耗時(shí)方法 的methodId
threadStack：堆棧信息
processPriority：動(dòng)態(tài)線程優(yōu)先級(jí)
processNice：（靜態(tài)線程優(yōu)先級(jí)）
isProcessForeground：是否是后臺(tái)線程
memory：內(nèi)存情況包含如下三部分
    dalvik_heap：dalvik已使用內(nèi)存大?。↘B）
    native_heap：native已使用內(nèi)存大小（KB）
    vm_size：虛擬內(nèi)存總大小

系列文章

參考資料

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容