Android NDK की क्रैश रिपोर्ट पाएं

अगर आपके Android ऐप्लिकेशन में नेटिव लाइब्रेरी हैं, तो Firebase Crashlytics से अपने नेटिव कोड के लिए फ़ुल स्टैक ट्रेस और क्रैश रिपोर्ट की ज़्यादा जानकारी पाने की सुविधा चालू की जा सकती है. इसके लिए, आपको अपने ऐप्लिकेशन के बिल्ड कॉन्फ़िगरेशन में कुछ छोटे-मोटे अपडेट शामिल करने होंगे.

इस गाइड में एनडीके के लिए, Firebase Crashlytics SDK टूल की मदद से क्रैश होने की रिपोर्ट को कॉन्फ़िगर करने का तरीका बताया गया है.

अगर आपको अपने Unity प्रोजेक्ट में Crashlytics का इस्तेमाल शुरू करने का तरीका जानना है, तो Unity के लिए शुरुआती निर्देश देखें.

वेब कंटेनर इंस्टॉल करने से पहले

  1. अगर आपने पहले से ऐसा नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें. अगर आपके पास Android ऐप्लिकेशन नहीं है, तो ऐप्लिकेशन का नमूना डाउनलोड किया जा सकता है.

  2. सुझाव: अपने-आप ब्रेडक्रंब लॉग पाने के लिए, आपको अपने Firebase प्रोजेक्ट में Google Analytics चालू करना होगा. इससे उपयोगकर्ता की उन कार्रवाइयों को समझने में मदद मिलेगी जो क्रैश होने, नुकसान न पहुंचाने वाली या ANR इवेंट की वजह से होती हैं.

    • अगर आपके मौजूदा Firebase प्रोजेक्ट में Google Analytics चालू नहीं है, तो आप Firebase कंसोल में > प्रोजेक्ट सेटिंग के इंटिग्रेशन टैब से Google Analytics को चालू कर सकते हैं.

    • अगर कोई नया Firebase प्रोजेक्ट बनाया जा रहा है, तो प्रोजेक्ट बनाने के वर्कफ़्लो के दौरान Google Analytics चालू करें.

  3. पक्का करें कि आपके ऐप्लिकेशन में, कम से कम इन वर्शन की ज़रूरत हो:

    • ग्रेडल 8.0
    • 'Android Gradle प्लग इन 8.1.0'
    • Google सेवाओं के लिए Gradle प्लग इन 4.4.1

पहला चरण: अपने ऐप्लिकेशन में एनडीके के लिए Crashlytics SDK टूल जोड़ना

अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर, <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए Crashlytics NDK लाइब्रेरी के लिए डिपेंडेंसी जोड़ें. लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, हम Firebase Android BoM का इस्तेमाल करने का सुझाव देते हैं.

Crashlytics का इस्तेमाल करने का बेहतर अनुभव पाने के लिए, हमारा सुझाव है कि आप अपने Firebase प्रोजेक्ट में Google Analytics चालू करें. साथ ही, अपने ऐप्लिकेशन में Google Analytics के लिए Firebase SDK टूल जोड़ें. 

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

    // 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 लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

(वैकल्पिक) BoM का इस्तेमाल किए बिना Firebase लाइब्रेरी डिपेंडेंसी जोड़ें

अगर आप Firebase BoM का इस्तेमाल नहीं करना चाहते हैं, तो आपको उसकी डिपेंडेंसी लाइन में Firebase लाइब्रेरी के हर वर्शन की जानकारी देनी होगी.

ध्यान दें कि अगर आप अपने ऐप्लिकेशन में कई Firebase लाइब्रेरी का इस्तेमाल करते हैं, तो हमारा सुझाव है कि लाइब्रेरी के वर्शन मैनेज करने के लिए, BoM का इस्तेमाल करें. इससे यह पक्का होता है कि ऐप्लिकेशन के सभी वर्शन काम करते हैं. 

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.2")
    implementation("com.google.firebase:firebase-analytics:22.0.2")
}
क्या आपको Kotlin से जुड़े लाइब्रेरी मॉड्यूल की तलाश है? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java डेवलपर, दोनों मुख्य लाइब्रेरी मॉड्यूल पर निर्भर कर सकते हैं. ज़्यादा जानकारी के लिए, इस इनिशिएटिव के बारे में अक्सर पूछे जाने वाले सवाल देखें.

दूसरा चरण: अपने ऐप्लिकेशन में Crashlytics Gradle प्लग इन जोड़ना

  1. अपनी रूट-लेवल (प्रोजेक्ट-लेवल) की Gradle फ़ाइल (<project>/build.gradle.kts या <project>/build.gradle) में, plugins ब्लॉक में Crashlytics Gradle प्लग इन जोड़ें:

    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'
}

तीसरा चरण: अपने बिल्ड में Crashlytics एक्सटेंशन जोड़ना

अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर, <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Crashlytics एक्सटेंशन को कॉन्फ़िगर करें.

Kotlin 

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

Groovy 

// ...

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

चौथा चरण: नेटिव सिंबल अपने-आप अपलोड होने की सुविधा सेट अप करना

एनडीके क्रैश से ऐसे स्टैक ट्रेस बनाए जा सकें जिन्हें पढ़ा जा सके, इसके लिए Crashlytics को आपकी नेटिव बाइनरी में मौजूद सिंबल के बारे में जानकारी होनी चाहिए. Crashlytics Gradle प्लग इन में इस प्रोसेस को ऑटोमेट करने के लिए uploadCrashlyticsSymbolFileBUILD_VARIANT टास्क शामिल है.

  1. अपने-आप सिंबल अपलोड करने के टास्क को ऐक्सेस करने के लिए, पक्का करें कि आपके मॉड्यूल (ऐप्लिकेशन लेवल की) Gradle फ़ाइल में nativeSymbolUploadEnabled को true पर सेट किया गया हो.

  2. स्टैक ट्रेस में तरीकों के नाम दिखाने के लिए, आपको अपनी एनडीके लाइब्रेरी के हर बिल्ड के बाद साफ़ तौर पर uploadCrashlyticsSymbolFileBUILD_VARIANT टास्क शुरू करना होगा. उदाहरण के लिए:

    >./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT

  3. एनडीके के लिए Crashlytics SDK टूल और Crashlytics Gradle प्लग इन, दोनों नेटिव शेयर किए गए ऑब्जेक्ट में GNU बिल्ड आईडी की मौजूदगी पर निर्भर करते हैं.

    इस आईडी की मौजूदगी की पुष्टि करने के लिए, हर बाइनरी पर readelf -n चलाएं. अगर बिल्ड आईडी मौजूद नहीं है, तो इस समस्या को ठीक करने के लिए, अपने बिल्ड सिस्टम के फ़्लैग में -Wl,--build-id जोड़ें.

पांचवां चरण: सेटअप पूरा करने के लिए, टेस्ट क्रैश को हर हाल में पूरा करना

Crashlytics का सेट अप पूरा करने और Firebase कंसोल के Crashlytics डैशबोर्ड में शुरुआती डेटा देखने के लिए, आपको ज़बरदस्ती टेस्ट बंद करना होगा.

  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. अपने टेस्ट क्रैश को देखने के लिए Firebase कंसोल के Crashlytics डैशबोर्ड पर जाएं.

    अगर आपने कंसोल रीफ़्रेश कर दिया है और पांच मिनट बाद भी टेस्ट क्रैश नहीं दिख रहा है, तो डीबग लॉगिंग को चालू करें. इससे आपको पता चलेगा कि आपका ऐप्लिकेशन क्रैश रिपोर्ट भेज रहा है या नहीं.


बस इतना ही! Crashlytics, अब आपके ऐप्लिकेशन के क्रैश होने पर उसे मॉनिटर करता है. साथ ही, Crashlytics के डैशबोर्ड में क्रैश रिपोर्ट और आंकड़े देखे जा सकते हैं और उनकी जांच की जा सकती है.

अगले चरण

  • (इसका सुझाव दिया जाता है) GWP-ASan रिपोर्ट इकट्ठा करके, नेटिव मेमोरी की गड़बड़ियों की वजह से होने वाले क्रैश को डीबग करने में मदद पाएं. मेमोरी से जुड़ी ये गड़बड़ियां, आपके ऐप्लिकेशन में मेमोरी के ठीक से काम न करने की वजह से हो सकती हैं. यही वजह है कि ऐप्लिकेशन के लिए सुरक्षा से जुड़े जोखिम पैदा हो सकते हैं. डीबग करने की इस सुविधा का फ़ायदा पाने के लिए, पक्का करें कि आपके ऐप्लिकेशन में GWP-ASan को साफ़ तौर पर चालू किया गया हो और NDK (v18.3.6+ या Firebase BoM v31.3.0+) के लिए, सबसे नए Crashlytics SDK टूल का इस्तेमाल किया गया हो.

  • ऑप्ट-इन रिपोर्टिंग, लॉग, कुंजियां, और साधारण गड़बड़ियों की ट्रैकिंग जोड़कर अपने क्रैश रिपोर्ट सेटअप को कस्टमाइज़ करें.

  • Google Play के साथ इंटिग्रेट करें, ताकि Google Play ट्रैक के हिसाब से, अपने Android ऐप्लिकेशन की क्रैश रिपोर्ट को सीधे Crashlytics डैशबोर्ड में फ़िल्टर किया जा सके. इससे आपको अपने डैशबोर्ड को खास बिल्ड पर बेहतर तरीके से फ़ोकस करने में मदद मिलती है.

समस्या हल करना

अगर आपको Firebase कंसोल और लॉगकैट में अलग-अलग स्टैक ट्रेस दिख रहे हैं, तो समस्या का हल करने वाली गाइड देखें.


सिंबल अपलोड करने के दूसरे विकल्प

ऊपर इस पेज पर मौजूद मुख्य वर्कफ़्लो, स्टैंडर्ड Gradle बिल्ड के लिए लागू होता है. हालांकि, कुछ ऐप्लिकेशन अलग कॉन्फ़िगरेशन या टूल का इस्तेमाल करते हैं (उदाहरण के लिए, Gradle के अलावा कोई अन्य बिल्ड प्रोसेस). ऐसे में, नीचे दिए गए विकल्पों से प्रज़ेंट को अपलोड करने में मदद मिल सकती है.

विकल्प: लाइब्रेरी मॉड्यूल और बाहरी डिपेंडेंसी के लिए सिंबल अपलोड करना

यह विकल्प इन स्थितियों में मददगार हो सकता है:

  • अगर Gradle में पसंद के मुताबिक एनडीके बिल्ड प्रोसेस इस्तेमाल की जाती है
  • अगर आपकी नेटिव लाइब्रेरी, लाइब्रेरी/सुविधा वाले मॉड्यूल में बनाई गई हैं या तीसरे पक्ष ने उपलब्ध कराई हैं
  • अगर अपने-आप सिंबल अपलोड करने वाला टास्क काम नहीं कर रहा है या आपको डैशबोर्ड में ऐसे क्रैश दिख रहे हैं जिनमें कोई गड़बड़ी नहीं हुई

विकल्प: नॉन-ग्रेडल बिल्ड या ऐक्सेस न की जा सकने वाली बिना नेटिव नेटिव लाइब्रेरी के लिए सिंबल अपलोड करें

यह विकल्प इन स्थितियों में मददगार हो सकता है:

  • अगर Gradle के अलावा किसी अन्य बिल्ड प्रोसेस का इस्तेमाल किया जाता है

  • अगर आपकी सामान्य नेटिव लाइब्रेरी इस तरह दी गई हैं कि वे Gradle बिल्ड के दौरान ऐक्सेस नहीं की जा सकतीं