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

หากแอป 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 ของบริการของ Google 4.4.1

ขั้นตอนที่ 1: เพิ่ม Crashlytics SDK สําหรับ NDK ลงในแอป

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

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.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.3.0")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

ขั้นตอนที่ 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.2" apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id("com.google.firebase.crashlytics") version "3.0.2" 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.2' apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics' version '3.0.2' 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 ลงในบิลด์

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

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 ในไฟล์ Gradle ของโมดูล (ระดับแอป) เพื่อให้เข้าถึงงานสำหรับการอัปโหลดสัญลักษณ์อัตโนมัติได้

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

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT

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

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

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

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

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

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

   Kotlin

   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) ในกรณีเหล่านี้ ตัวเลือกต่อไปนี้อาจเป็นประโยชน์ในการอัปโหลดสัญลักษณ์ให้สำเร็จ

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

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

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

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

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

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

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