Android एनडीके की क्रैश रिपोर्ट पाएं

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

इस गाइड में बताया गया है कि एनडीके के लिए Firebase Crashlytics एसडीके.

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

शुरू करने से पहले

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

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

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

    • अगर कोई नया Firebase प्रोजेक्ट बनाया जा रहा है, तो Google Analytics चालू करें का इस्तेमाल किया जाता है.

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

    • ग्रेडल 8.0
    • 'Android Gradle प्लग इन 8.1.0'
    • Google services 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 के साथ बेहतर अनुभव के लिए, हमारा सुझाव है कि Google Analytics को चालू किया जा रहा है जोड़ना होगा. साथ ही, अपने ऐप्लिकेशन में Google Analytics के लिए Firebase SDK टूल जोड़ना होगा.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.2.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 लाइब्रेरी के काम करने वाले वर्शन का इस्तेमाल करेगा.

(विकल्प)  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.3")
    implementation("com.google.firebase:firebase-analytics:22.1.0")
}
क्या आपको 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. अपने-आप सिंबल अपलोड करने के लिए, टास्क को ऐक्सेस करने के लिए, पक्का करें कि कि nativeSymbolUploadEnabled को आपके मॉड्यूल में true पर सेट किया गया है (ऐप्लिकेशन-लेवल) Gradle फ़ाइल.

  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. इसके Crashlytics डैशबोर्ड पर जाएं Firebase कंसोल का इस्तेमाल करें.

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


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

अगले चरण

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

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

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

समस्या का हल

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



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

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

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

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

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

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

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

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

  • अगर आपकी नेटिव लाइब्रेरी बिना किसी रुकावट के उपलब्ध हैं, तो वे Gradle बिल्ड के दौरान ऐक्सेस नहीं हो पाते