รับรายงานข้อขัดข้องของ Android NDK

หากแอป Android ของคุณมี ไลบรารี เนทีฟ คุณสามารถเปิดใช้การติดตามสแต็กแบบเต็มและรายงานข้อขัดข้องโดยละเอียดสำหรับโค้ดเนทีฟจาก Firebase Crashlytics โดยมีการอัปเดตเล็กน้อยในการกำหนดค่าบิวด์ของแอป

คู่มือนี้อธิบายวิธีกำหนดค่าการรายงานข้อขัดข้องด้วย Firebase Crashlytics SDK สำหรับ NDK

หากคุณกำลังมองหาวิธีเริ่มต้นใช้งาน Crashlytics ในโครงการ Unity ของคุณ โปรดดูคู่มือ การเริ่มต้นใช้งาน Unity

ก่อนจะเริ่ม

1. หากคุณยังไม่ได้ เพิ่ม Firebase ในโครงการ Android ของคุณ หากคุณไม่มีแอป Android คุณสามารถดาวน์โหลด แอปตัวอย่าง

2. แนะนำ : หากต้องการรับคุณลักษณะต่างๆ เช่น ผู้ใช้ที่ไม่มีข้อขัดข้อง บันทึกการแสดงเส้นทาง และการแจ้งเตือนความเร็ว คุณต้องเปิดใช้ Google Analytics ในโครงการ Firebase

   • หากโปรเจ็กต์ Firebase ที่คุณมีอยู่ไม่ได้เปิดใช้งาน Google Analytics คุณสามารถเปิดใช้งาน Google Analytics ได้จาก แท็บ การผสานการ ทำงานใน settings > การตั้ง ค่าโปรเจ็ กต์ในคอนโซล Firebase

   • หากคุณกำลังสร้างโปรเจ็กต์ Firebase ใหม่ ให้เปิดใช้ Google Analytics ระหว่างขั้นตอนการสร้างโปรเจ็กต์

ขั้นตอนที่ 1 : เพิ่ม Firebase Crashlytics SDK สำหรับ NDK ในแอปของคุณ

เพื่อประสบการณ์การใช้งาน Crashlytics ที่ดีที่สุด เราขอแนะนำให้ เปิดใช้ Google Analytics ในโปรเจ็กต์ Firebase และเพิ่ม Firebase SDK สำหรับ Google Analytics ในแอปของคุณ

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.1.0')

    // Declare the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics'
}

dependencies {
    // Declare the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.2.11'
    implementation 'com.google.firebase:firebase-analytics:21.0.0'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:30.1.0')

    // Declare the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics-ktx'
}

dependencies {
    // Declare the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.2.11'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.0.0'
}

ขั้นตอนที่ 2 : เพิ่มปลั๊กอิน Firebase Crashlytics ในแอปของคุณ

1. ในไฟล์ build.gradle ระดับโปรเจ็กต์ ของคุณ ให้เพิ่มปลั๊กอิน Crashlytics Gradle เป็นการพึ่งพา buildscript

   buildscript {
       repositories {
           // Check that you have Google's Maven repository (if not, add it).
           google()
       }
   
       dependencies {
           // ...
   
           // Check that you have the Google services Gradle plugin v4.3.2 or later
           // (if not, add it).
           classpath 'com.google.gms:google-services:4.3.10'
   
           // Add the Crashlytics Gradle plugin
           classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.0'
       }
   }
   
   allprojects {
       repositories {
           // Check that you have Google's Maven repository (if not, add it).
           google()
       }
   }

2. ในไฟล์ build.gradle ระดับแอป ให้ใช้ปลั๊กอิน Crashlytics Gradle:

   apply plugin: 'com.android.application'
   apply plugin: 'com.google.gms.google-services' // Google services Gradle plugin
   
   // Apply the Crashlytics Gradle plugin
   apply plugin: 'com.google.firebase.crashlytics'
   

ขั้นตอนที่ 3 : เพิ่มส่วนขยาย firebaseCrashlytics ให้กับงานสร้างของคุณ

ใน ไฟล์ Gradle ของโมดูล (ระดับแอป) (ปกติคือ app/build.gradle ) ให้เพิ่มส่วนขยาย firebaseCrashlytics

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

ขั้นตอนที่ 4 : ตั้งค่าการอัปโหลดสัญลักษณ์ดั้งเดิมโดยอัตโนมัติ

ในการสร้างสแต็กเทรซที่อ่านได้จากการขัดข้องของ NDK Crashlytics จำเป็นต้องรู้เกี่ยวกับสัญลักษณ์ในไบนารีเนทีฟของคุณ ปลั๊กอิน Crashlytics Gradle มีงาน uploadCrashlyticsSymbolFile BUILD_VARIANT เพื่อทำให้กระบวนการนี้เป็นแบบอัตโนมัติ

1. เพื่อให้คุณสามารถเข้าถึงงานสำหรับการอัปโหลดสัญลักษณ์อัตโนมัติ ตรวจสอบให้แน่ใจว่า nativeSymbolUploadEnabled ถูกตั้งค่า true ในไฟล์ Gradle ของโมดูล (ระดับแอป)

2. เพื่อให้ชื่อเมธอดปรากฏในสแต็กเทรซของคุณ คุณต้องเรียกใช้งาน uploadCrashlyticsSymbolFile BUILD_VARIANT อย่างชัดเจน หลังจากแต่ละบิลด์ของไลบรารี NDK ของคุณ ตัวอย่างเช่น:

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT
   

3. ทั้ง Crashlytics SDK สำหรับ NDK และปลั๊กอิน Crashlytics Gradle ขึ้นอยู่กับการมีอยู่ของ GNU build ID ภายในอ็อบเจ็กต์ที่แชร์ในเครื่อง

   คุณสามารถตรวจสอบการมีอยู่ของ ID นี้ได้โดยเรียกใช้ readelf -n ในแต่ละไบนารี หากไม่มี build ID ให้เพิ่ม -Wl,--build-id ในแฟล็กของระบบบิลด์ของคุณเพื่อแก้ไขปัญหา

ขั้นตอนที่ 5 : บังคับให้หยุดการทดสอบเพื่อสิ้นสุดการตั้งค่า

หากต้องการตั้งค่า Crashlytics ให้เสร็จสิ้นและดูข้อมูลเบื้องต้นในแดชบอร์ด Crashlytics ของคอนโซล Firebase คุณต้องบังคับให้มีการทดสอบขัดข้อง

1. เพิ่มโค้ดในแอปของคุณเพื่อใช้บังคับการทดสอบขัดข้อง

   คุณสามารถใช้โค้ดต่อไปนี้ใน MainActivity ของแอปเพื่อเพิ่มปุ่มลงในแอปที่เมื่อกดแล้วจะทำให้เกิดข้อขัดข้อง ปุ่มนี้มีชื่อว่า "Test Crash"

   Java

   Button crashButton = new Button(this);
   crashButton.setText("Test Crash");
   crashButton.setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
          throw new RuntimeException("Test Crash"); // Force a crash
      }
   });
   
   addContentView(crashButton, new ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT));
   

   Kotlin+KTX

   val crashButton = Button(this)
   crashButton.text = "Test Crash"
   crashButton.setOnClickListener {
      throw RuntimeException("Test Crash") // Force a crash
   }
   
   addContentView(crashButton, ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT))
   

2. สร้างและเรียกใช้แอปของคุณ

3. บังคับให้การทดสอบขัดข้องเพื่อส่งรายงานข้อขัดข้องแรกของแอป:

   1. เปิดแอปของคุณจากอุปกรณ์ทดสอบหรือโปรแกรมจำลอง

   2. ในแอปของคุณ ให้กดปุ่ม "ทดสอบการขัดข้อง" ที่คุณเพิ่มโดยใช้โค้ดด้านบน

   3. หลังจากที่แอปของคุณขัดข้อง ให้รีสตาร์ทเพื่อให้แอปของคุณสามารถส่งรายงานข้อขัดข้องไปยัง Firebase

4. ไปที่ แดชบอร์ด Crashlytics ของคอนโซล Firebase เพื่อดูข้อขัดข้องของการทดสอบ

   หากคุณได้รีเฟรชคอนโซลแล้วและยังไม่เห็นการทดสอบขัดข้องหลังจากผ่านไปห้านาที ให้เปิดใช้งานการบันทึกการแก้ไขข้อบกพร่อง เพื่อดูว่าแอปของคุณส่งรายงานข้อขัดข้องหรือไม่

และนั่นแหล่ะ! ตอนนี้ Crashlytics กำลังตรวจสอบแอปของคุณเพื่อหาข้อขัดข้อง และคุณสามารถดูและตรวจสอบรายงานข้อขัดข้องและสถิติในแดชบอร์ด Crashlytics

ตัวเลือกอื่นสำหรับการอัพโหลดสัญลักษณ์

เวิร์กโฟลว์หลักในหน้านี้ด้านบนใช้ได้กับรุ่น Gradle มาตรฐาน อย่างไรก็ตาม บางแอปใช้การกำหนดค่าหรือเครื่องมือที่แตกต่างกัน (เช่น กระบวนการสร้างอื่นที่ไม่ใช่ Gradle) ในสถานการณ์เหล่านี้ ตัวเลือกต่อไปนี้อาจเป็นประโยชน์สำหรับการอัปโหลดสัญลักษณ์ได้สำเร็จ

ตัวเลือก : อัปโหลดสัญลักษณ์สำหรับโมดูลไลบรารีและการพึ่งพาภายนอก

ตัวเลือกนี้จะมีประโยชน์ในสถานการณ์ต่อไปนี้:

• หากคุณใช้กระบวนการสร้าง NDK ที่กำหนดเองภายใน Gradle
• หากไลบรารีดั้งเดิมของคุณสร้างขึ้นในโมดูลไลบรารี/คุณลักษณะหรือจัดหาโดยบุคคลที่สาม
• หาก งานอัปโหลดสัญลักษณ์อัตโนมัติ ล้มเหลวหรือคุณเห็นการขัดข้องที่ไม่มีสัญลักษณ์ในแดชบอร์ด

ตัวเลือก : อัปโหลดสัญลักษณ์สำหรับบิลด์ที่ไม่ใช่ Gradle หรือไลบรารีเนทีฟที่ไม่สามารถเข้าถึงได้

ตัวเลือกนี้จะมีประโยชน์ในสถานการณ์ต่อไปนี้:

• หากคุณใช้กระบวนการสร้างอื่นที่ไม่ใช่ Gradle

• หากไลบรารีเนทีฟแบบ unstripped ของคุณมีให้ในลักษณะที่ไม่สามารถเข้าถึงได้ระหว่าง Gradle builds

การแก้ไขปัญหา

หากคุณเห็นสแต็กเทรซต่างๆ ในคอนโซล Firebase และใน logcat ให้อ้างอิงกับ คู่มือการแก้ไขปัญหา

ขั้นตอนถัดไป

• ปรับแต่งการตั้งค่ารายงานข้อขัดข้อง ด้วยการเพิ่มการรายงาน บันทึก คีย์ และการติดตามข้อผิดพลาดที่ไม่ร้ายแรง

• ผสานรวมกับ Google Play เพื่อให้คุณสามารถกรองรายงานข้อขัดข้องของแอป Android ตามแทร็ก Google Play ได้โดยตรงในแดชบอร์ดของ Crashlytics ซึ่งจะทำให้คุณสามารถโฟกัสแดชบอร์ดของคุณไปที่บิลด์เฉพาะได้ดีขึ้น