符号表

什么是符号表?

符号表是内存地址与函数名、文件名、行号的映射表。符号表元素如下所示:
<起始地址> <结束地址> <函数> [<文件名:行号>]

为什么要配置符号表?

为了能快速并准确地定位用户APP发生Crash的代码位置,AppInsights使用符号表对APP发生Crash的程序堆栈进行解析和还原。
第一种:so符号表
举一个例子:

第二种:mapping文件
mapping文件用于对混淆后的代码进行还原,详见:https://developer.android.com/studio/build/shrink-code?hl=zh-cn#obfuscate

iOS符号表

什么是dSYM文件?

iOS平台中,dSYM文件是指具有调试信息的目标文件,文件名通常为:xxx.app.dSYM。如下图所示:

为了方便找回Crash对应的dSYM文件和还原堆栈,建议每次构建或者发布APP版本的时候,备份好dSYM文件。

如何定位dSYM文件?

一般情况下,项目编译完dSYM文件跟app文件在同一个目录下,下面以XCode作为IDE详细说明定位dSYM文件。
-> 进入XCode;
-> 打开工程(已编译过);
-> 在左栏找到“Product”项;
-> 鼠标右键点击编译生成的“xxx.app”;
-> 点击“Show in Finder”;
如下图所示:


如果有多个dSYM文件,可以在使用工具时指定输入为dSYM文件所在的目录或者工程目录。

XCode编译后没有生成dSYM文件?

XCode Release编译默认会生成dSYM文件,而Debug编译默认不会生成,对应的Xcode配置如下:
XCode -> Build Settings -> Code Generation -> Generate Debug Symbols -> Yes

XCode -> Build Settings -> Build Option -> Debug Information Format -> DWARF with dSYM File

开启Bitcode之后需要注意哪些问题?

  • 在点“Upload to App Store”上传到App Store服务器的时候需要声明符号文件(dSYM文件)的生成:
  • 在配置符号表文件之前,需要从App Store中把该版本对应的dSYM文件下载回本地(参考“如何找回已发布到App Store的App对应的dSYM文件?”),然后上传符号表文件。
  • 不需要配置自动生成符号表的脚本了,也不要用本地生成的dSYM文件来生成符号表文件,因为本地编译生成的dSYM文件的符号表信息都被隐藏了。如果用本地编译生成的dSYM文件生成符号表文件并配置到AppInsights平台之后,还原出来的结果将是类似于“__hiden#XXX”这样的符号。

如何判断dSYM文件是否与Crash的UUID匹配?

AppInsights还原Crash堆栈时,需要根据UUID来匹配符号表文件,因此只有上传的符号表文件的UUID与Crash对应APP的UUID一致时,才能准确地对堆栈进行还原。
查看符号表文件的UUID(“如何查看dSYM文件的UUID?”)
查看Crash对应的APP的UUID
崩溃详情里的符号表截图

如何查看dSYM文件的UUID?

通过命令查看UUID
xcrun dwarfdump --uuid <dSYM文件>
通过符号表文件查看UUID
符号表文件的UUID与dSYM文件的UUID是一致的,因此可以通过符号表工具生成的符号表文件来查看dSYM文件的UUID:
生成符号表文件(.zip) ---> 解压符号表文件(.symbol) ---> 使用文本编辑器打开符号表文件

其中符号表文件的“UUID”信息即Debug SO文件的UUID,亦是符号表文件的UUID,如果文件较大,建议使用“Sublime Text”等文本编辑器来打开符号表文件。

如何找回已发布到App Store的App对应的dSYM文件?

通过Xcode找回
1.打开 Xcode 顶部菜单栏 -> Window -> Organizer 窗口:
2.打开 Xcode 顶部菜单栏,选择 Archive 标签:

3.找到发布的归档包,右键点击对应归档包,选择Show in Finder操作:

4.右键选择定位到的归档文件,选择显示包内容操作:

5.选择dSYMs目录,目录内即为下载到的 dSYM 文件:

通过iTunes Connect找回
1.登录https://itunesconnect.apple.com/;
2.进入“我的App(My Apps)”的“活动(Activity)”页面:

3.在“所有构件版本(All Builds)”中选择某一个版本,点“下载dSYM(Download dSYM)”下载dSYM文件:

通过mdfind工具找回
1.在AppInsights的issue页面查询到crash对应的UUID:
2.然后在Mac的Shell中,用mdfind命令定位dSYM文件:
mdfind "com_apple_xcode_dsym_uuids == <UUID>"

注意,使用mdfind时,UUID需要格式转换(增加“-”): 12345678-1234-1234-1234-xxxxxxxxxxxx
例如,要定位的dSYM的UUID为:E30FC309DF7B3C9F8AC57F0F6047D65F 则定位dSYM文件的命令如下:
mdfind "com_apple_xcode_dsym_uuids == E30FC309-DF7B-3C9F-8AC5-7F0F6047D65F"
|12345678-1234-1234-1234-xxxxxxxxxxxx|
建议每次构建或者发布APP版本的时候,备份App对应的dSYM文件!

Android符号表

怎么找到符号表?

SO符号表位置
Android平台中,Debug SO文件是指具有调试信息的SO文件,其中包含用户还原堆栈的 符号信息。
为了方便找回Crash对应的Debug SO文件和还原堆栈,建议每次构建或者发布APP版本的 时候,备份好Debug SO文件。
CMake编译项目: 默认情况下,Debug编译的Debug SO文件将位于:
<项目文件夹>/<Module>/build/intermediates/cmake/debug/obj/local<架构>/

NDK编译项目: 默认情况下,Debug编译的Debug SO文件将位于:
<项目文件夹>/<Module>/build/intermediates/ndk/debug/obj/local<架构>/
而Release编译的Debug SO文件将位于:
<项目文件夹>/<Module>/build/intermediates/ndk/release/obj/local<架构>
如下图所示:

mapping文件位置
默认情况下,mapping文件位置在:
<项目文件夹><Module>/build/outputs/mapping/<build-type>/

如何判断是否与Crash匹配?

AppInsights还原Native Crash堆栈时,需要根据UUID来匹配符号表文件,因此只有上传的符号表文件的UUID与Native Crash堆栈的SO文件的UUID一致时(从后往前匹配),才能准确地对堆栈进行还原。
查看Native Crash对应的APP的UUID: 崩溃分析 —-> Crash issue —-> 符号表 —-> UUID

如何查看Debug SO文件的UUID?

符号表文件的UUID与Debug SO文件的UUID是一致的,因此可以通过符号表工具生成的 符号表文件来查看Debug SO文件的UUID:
生成符号表文件(.zip) ---> 解压符号表文件(.symbol) ---> 使用文本编辑器打开符号表文件

其中符号表文件的“SHA-1”信息即Debug SO文件的UUID,亦是符号表文件的UUID,如 果文件较大,建议使用“Sublime Text”等文本编辑器来打开符号表文件。
由AppInsights已采用新的UUID计算规则,为了能正确地匹配Crash堆栈对应的SO文件,请使用2.5.0或以上版本的符号表工具。

找不到Crash对应的Debug SO文件如何处理?

如果本地已经无法找到Crash对应的符号表文件或者Debug SO文件了,但还能找回Crash 对应的APP版本的Native工程代码,建议尝试重新用NDK编译出Debug SO文件并用符号 表工具生成符号表文件。
如果连Native工程代码也无法找回了,那就真的无法还原这个Crash堆栈了。
为了防止出现这种情况,建议每次构建或者发布APP版本的时候,一定要备份好Debug SO文件!

如何上传符号表到AppInsights平台?

1.在页面左侧导航栏,选择异常配置 > 符号表管理,打开符号表页面;
2.Android应用选择Mapping符号表或So符号表页签,iOS应用选择dSYM符号表页签;
3.单击文件上传,在上传面板中选择文件,单击确定,完成上传任务。