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

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

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

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

ก่อนเริ่มต้น

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

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

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

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

3. ตรวจสอบว่าแอปมีเวอร์ชันขั้นต่ำต่อไปนี้ที่จำเป็น

   • Gradle 8.0
   • ปลั๊กอิน Android Gradle 8.1.0
   • ปลั๊กอิน Gradle 4.4.1 ของบริการของ Google

ขั้นตอนที่ 1: เพิ่ม 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:33.0.0"))

    // Add 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")
}

การใช้ Firebase Android BoM จะทำให้แอปใช้ไลบรารี Firebase Android เวอร์ชันที่เข้ากันได้เสมอ

dependencies {
    // Add 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:19.0.0")
    implementation("com.google.firebase:firebase-analytics:22.0.0")
}

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

1. ในไฟล์ Gradle ระดับรูท (ระดับโปรเจ็กต์) (<project>/build.gradle.kts หรือ <project>/build.gradle) ให้เพิ่มปลั๊กอิน Crashlytics Gradle ลงในบล็อก plugins ดังนี้

   Kotlin

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id("com.android.application") version "8.1.4" apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id("com.google.gms.google-services") version "4.4.1" apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id("com.google.firebase.crashlytics") version "3.0.0" apply false
   }
   

   Groovy

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id 'com.android.application' version '8.1.4' apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id 'com.google.gms.google-services' version '4.4.1' apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics' version '3.0.0' apply false
   }
   

2. ในโมดูล (ระดับแอป) ไฟล์ Gradle (โดยปกติจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่มปลั๊กอิน Crashlytics Gradle ดังนี้

   Kotlin

   plugins {
     id("com.android.application")
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id("com.google.gms.google-services")
   
     // Add the Crashlytics Gradle plugin
     id("com.google.firebase.crashlytics")
   }

   Groovy

   plugins {
     id 'com.android.application'
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id 'com.google.gms.google-services'
   
     // Add the Crashlytics Gradle plugin
     id 'com.google.firebase.crashlytics'
   }

ขั้นตอนที่ 3: เพิ่มส่วนขยาย Crashlytics ลงในบิลด์

กำหนดค่าส่วนขยาย Crashlytics ในโมดูล (ระดับแอป) ไฟล์ Gradle (โดยปกติจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle)

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
  // ...
  buildTypes {
      getByName("release") {
          // Add this extension
          configure<CrashlyticsExtension> {
              // 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: ตั้งค่าการอัปโหลดสัญลักษณ์เนทีฟโดยอัตโนมัติ

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

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

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

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT
   

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

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

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

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

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

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

   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))
   

   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));
   

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

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

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

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

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

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

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

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

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

• (แนะนำ) รับความช่วยเหลือในการแก้ไขข้อบกพร่องข้อขัดข้องที่เกิดจากข้อผิดพลาดของหน่วยความจําของระบบโดยรวบรวมรายงานของ GWP-ASan ข้อผิดพลาดเกี่ยวกับหน่วยความจำเหล่านี้อาจเกี่ยวข้องกับความเสียหายของหน่วยความจำภายในแอป ซึ่งเป็นสาเหตุหลักที่ทำให้เกิดช่องโหว่ด้านความปลอดภัยของแอป หากต้องการใช้ประโยชน์จากฟีเจอร์การแก้ไขข้อบกพร่องนี้ โปรดตรวจสอบว่าแอปเปิดใช้ GWP-ASan อย่างชัดเจนและใช้ Crashlytics SDK เวอร์ชันล่าสุดสำหรับ NDK (v18.3.6+ หรือ Firebase BoM v31.3.0+)

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

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

การแก้ปัญหา

หากคุณเห็นสแต็กเทรซที่แตกต่างกันในคอนโซล Firebase และใน Logcat โปรดดูคู่มือการแก้ปัญหา

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

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

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

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

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

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

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

• หากคุณใช้กระบวนการบิลด์ที่ไม่ใช่ Gradle

• หากไลบรารีเนทีฟที่ยังไม่ได้ Strip จัดเตรียมไว้ให้คุณเข้าถึงไม่ได้ระหว่างการสร้าง Gradle