Firebase 上无 NDK 符号表的解决

Posted 2022-11-27 yxhuangCH

记 Firebase 上无 NDK 符号表解决的过程

背景

在 项目上线之后，Firebase 的后台收到音视频上报的崩溃。在项目中音视频以 so 文件的形式集成近项目。在后台上报页面，看不到符号表的匹配。

而这个 bug 占据了我们 bug 的 Top 1 位置。

解决过程

第一步 重新检查集成 Firebase 的过程
出现问题的时候，我们第一步是去官网重新看集成 Firebase 的过程
检查了发现没有问题。

第二步 重新查看官网文档
经过第一步的检查，集成的步骤是没有问题的, 我们再次看看官网文档，有没有新的发现。
在官网的 Get Android NDK crash reports 的这个章节发现了新的线索。

我们的音视频 so 是自己开发的，用 gradle 的方式集成到工程里面。这个相当于外部独立的依赖，所以，需要用 Firebase 提供的 unstrippedNativeLibsDir 的属性上传未剥离符号表的 so.
在第三步 Step 3(optinal): Upload symbols for external dependencies 中

// …
android 
    // ...
    buildTypes 
        release 
            firebaseCrashlytics 
                nativeSymbolUploadEnabled true
                unstrippedNativeLibsDir ‘path/to/unstripped/parent/dir’
            
        
    

并且需要对应的 so 架构

unstrippedNativeLibsDir/
 +- x86/
      |
      +- libfoo.so
      +- libbar.so
 +- arm64/
      |
      +- libfoo.so
      +- libbar.so

加了之后用命令执行 task 上传符号表

./gradlew app:assembleDebug app:uploadCrashlyticsSymbolFileDebug -debug | grep "\\[com.google.firebase.crashlytics\\]"

上面的命令跑了，之后发现我们上传符号表失败了，是因为网络的原因

第三步 Android　Studio 配置代理
我们在国内需要对 Android Studio 的 gradle 设置代理

设置 Android Studio 的代理
查看 SS 的端口

设置代理

• 1.找到 HTTP Proxy 设置选项
• 2.选择 Manual proxy configuration
• 3.填写 ss 的 ip 和端口
• 4.检测是否设置成功 check connection
  输入 google 的网址，检测是否设置成功，如果成功了，会弹窗连接成功的弹窗

第四步 去 Firebas 的github 上看 issues
经过上面三步还是不行，我们就去 Firebase 的 github 上看看其他人有没有遇到同样的问题。
这里顺便说一句，如果是开源的项目，遇到问题，查看它的 issues 也是解决问题的切入点，你遇到的问题，别人也会遇到，看看 issues 或许能找到解决办法或者提示。

在 Firebase 的 issues 中搜索 ndk symbol，可以找到相关 ndk 符号表的内容。然后在一条中找到相关的内容 Native crash reports missing symbol information (file name, line number, function name) #1978，有人也遇到相应的问题，就是在 Firebase 上没有看到相应的符号表。
他的解决办法，就是把已剥离和未剥离符号表的 so 都放到对于的目录下，用于上传符号表

debug 
    minifyEnabled false
    signingConfig signingConfigs.debugsign

    firebaseCrashlytics 
        nativeSymbolUploadEnabled true
        strippedNativeLibsDir 'nativelibs/stripped'  // 剥离符号表的 so
        unstrippedNativeLibsDir 'nativelibs/unstripped' // 未剥离符号表的 so
    

然后再执行命令

./gradlew app:assembleDebug app:uploadCrashlyticsSymbolFileDebug -debug | grep "\\[com.google.firebase.crashlytics\\]"

这次命令执行的结果显示,上传符号表成功了

Crashlytics symbol file uploaded successfully

经过测试 native 的崩溃后，发现符号表打印是上传成功了，但是还是没有显示出来。

到这来，我们已经没有办法。为什么明明符号表已经上传成功了，但是还是解析不到呢。

第四步 配对 So 和项目 NDK 版本

至此，唯一的可能性是我们上传的符号表和 native 的崩溃对不上，导致 Firebase 无法解析。

通过一番查找，发现我们构建 SO 用的 NDK 版本是 19， 构建项目是的 NDK 是 21 版本。
我们将项目的 NDK 版本也改成 19。

最后发现可以了。

总结

上传非工程直接编译 so 的符号表

第一 按照官方文档集成 Firebase
在项目级别的 build.gradle 中,添加 firebase

  dependencies 
      classpath 'com.google.firebase:firebase-crashlytics-gradle:2.1.1'
  

在 app 的 build.gradle 中添加

apply plugin: 'com.google.firebase.crashlytics'

....

buildTypes 

    release 
        ...
        firebaseCrashlytics 

            nativeSymbolUploadEnabled true
            strippedNativeLibsDir 'nativelibs/stripped'
            unstrippedNativeLibsDir 'nativelibs/unstripped'
        
    


    debug 
         ...
        firebaseCrashlytics 
            nativeSymbolUploadEnabled true
            strippedNativeLibsDir 'nativelibs/stripped'
            unstrippedNativeLibsDir 'nativelibs/unstripped'
        

strippedNativeLibsDir 是放已经剥离符号表的 so, unstrippedNativeLibsDir 是放未剥离符号表的 so

在 module 的 build.gradle 中添加依赖

dependencies 
    // google 崩溃上报
    implementation 'com.google.firebase:firebase-analytics-ktx:17.4.4'
    // Add the Firebase Crashlytics SDK.
    implementation 'com.google.firebase:firebase-crashlytics:17.1.1'
    implementation 'com.google.firebase:firebase-crashlytics-ndk:17.1.1'

第二步 确保网络没有问题
如果是在国内，要设置Android studio 代理

第三步 确保编译 so 的 NDK 和项目的 NDK 版本一致

第三步 用命令行上传符号表
用命令行上传符号表

./gradlew app:assembleDebug app:uploadCrashlyticsSymbolFileDebug -debug | grep "\\[com.google.firebase.crashlytics\\]"

跑命令的时候观察打印，如果打印出

Crashlytics symbol file uploaded successfully

则说明已经上传成功

第四步 测试 bug
打开 firebase 的 log 打印

adb shell setprop log.tag.FirebaseCrashlytics DEBUG

adb logcat -s FirebaseCrashlytics