Firebase Crashlytics का इस्तेमाल शुरू करें


इस शुरुआती लेख में, Firebase Crashlytics SDK टूल की मदद से अपने ऐप्लिकेशन में Firebase Crashlytics को सेट अप करने का तरीका बताया गया है. इससे आपको Firebase कंसोल में क्रैश की पूरी जानकारी वाली रिपोर्ट मिल सकती हैं.

Crashlytics को सेट अप करने के लिए, Firebase कंसोल और आपका IDE (जैसे, Firebase कॉन्फ़िगरेशन फ़ाइल और Crashlytics जोड़ना SDK टूल). सेटअप पूरा करने के लिए, आपको Firebase को अपनी पहली क्रैश रिपोर्ट भेजने के लिए, टेस्ट क्रैश करना होगा.

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

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

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

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

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

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

ध्यान दें कि अपने Firebase प्रोजेक्ट के साथ Unity प्रोजेक्ट को रजिस्टर करने पर, ऐसा हो सकता है कि पहले ही Firebase Unity SDK टूल डाउनलोड कर लिया गया हो और पैकेज जोड़ दिए गए हों इन चरणों में बताया गया है.

  1. Firebase Unity SDK टूल डाउनलोड करें. इसके बाद, SDK टूल को किसी दूसरी जगह अनज़िप करें. Firebase Unity SDK टूल, किसी खास प्लैटफ़ॉर्म के लिए नहीं है.

  2. अपने खुले हुए यूनिटी प्रोजेक्ट में, एसेट > पैकेज इंपोर्ट करें > कस्टम पैकेज पर जाएं.

  3. अनज़िप किए गए SDK टूल से, Crashlytics SDK टूल को इंपोर्ट करने का विकल्प चुनें (FirebaseCrashlytics.unitypackage).

    ब्रेडक्रंब लॉग का फ़ायदा पाने के लिए, अपने ऐप्लिकेशन (FirebaseAnalytics.unitypackage) में Google Analytics के लिए Firebase SDK टूल भी जोड़ें. पक्का करें कि आपके Firebase प्रोजेक्ट में Google Analytics चालू हो.

  4. Unity पैकेज को इंपोर्ट करें विंडो में, इंपोर्ट करें पर क्लिक करें.

दूसरा चरण: Crashlytics को शुरू करें

  1. एक नई C# स्क्रिप्ट बनाएं. इसके बाद, उसे सीन में GameObject में जोड़ें.

    1. अपना पहला सीन खोलें. इसके बाद, CrashlyticsInitializer नाम का खाली GameObject बनाएं.

    2. नए ऑब्जेक्ट के लिए, इंस्पेक्टर में कॉम्पोनेंट जोड़ें पर क्लिक करें.

    3. CrashlyticsInitializer ऑब्जेक्ट में जोड़ने के लिए, अपनी CrashlyticsInit स्क्रिप्ट चुनें.

  2. स्क्रिप्ट की Start विधि में Crashlytics शुरू करें:

    using System.Collections;
    using System.Collections.Generic;
    using UnityEngine;
    
    // Import Firebase and Crashlytics
    using Firebase;
    using Firebase.Crashlytics;
    
    public class CrashlyticsInit : MonoBehaviour {
        // Use this for initialization
        void Start () {
            // Initialize Firebase
            Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
                var dependencyStatus = task.Result;
                if (dependencyStatus == Firebase.DependencyStatus.Available)
                {
                    // Create and hold a reference to your FirebaseApp,
                    // where app is a Firebase.FirebaseApp property of your application class.
                    // Crashlytics will use the DefaultInstance, as well;
                    // this ensures that Crashlytics is initialized.
                    Firebase.FirebaseApp app = Firebase.FirebaseApp.DefaultInstance;
    
                    // When this property is set to true, Crashlytics will report all
                    // uncaught exceptions as fatal events. This is the recommended behavior.
                    Crashlytics.ReportUncaughtExceptionsAsFatal = true;
    
                    // Set a flag here for indicating that your project is ready to use Firebase.
                }
                else
                {
                    UnityEngine.Debug.LogError(System.String.Format(
                      "Could not resolve all Firebase dependencies: {0}",dependencyStatus));
                    // Firebase Unity SDK is not safe to use here.
                }
            });
        }
    
      // Update is called once per frame
      void Update()
        // ...
    }

तीसरा चरण: (सिर्फ़ Android के लिए) सिंबल अपलोड करने के लिए सेट अप करना

यह चरण सिर्फ़ उन Android ऐप्लिकेशन के लिए ज़रूरी है जो IL2CPP का इस्तेमाल करते हैं.

  • Unity के Mono scripting बैकएंड का इस्तेमाल करने वाले Android ऐप्लिकेशन के लिए, इन चरणों की ज़रूरत नहीं है.

  • Apple प्लैटफ़ॉर्म के ऐप्लिकेशन के लिए, इन चरणों की ज़रूरत नहीं है. इसकी वजह यह है कि Firebase Unity Editor प्लगिन, सिंबल अपलोड करने के लिए आपके Xcode प्रोजेक्ट को अपने-आप कॉन्फ़िगर कर देता है.

Crashlytics के Unity SDK 8.6.1 और उसके बाद के वर्शन में, क्रैश की जानकारी देने वाली NDK सुविधा अपने-आप शामिल होती है. इससे Crashlytics, Android पर UnityIL2CPP के क्रैश की जानकारी अपने-आप भेज सकता है. हालांकि, नेटिव लाइब्रेरी में सिम्बॉलिकेट्ड स्टैक ट्रेस देखने के लिए Crashlytics डैशबोर्ड में क्रैश हो जाता है, तो आपको यहां प्रतीक जानकारी अपलोड करनी होगी Firebase सीएलआई का इस्तेमाल करके समय बनाएं.

सिंबल अपलोड करने की सुविधा सेट अप करने के लिए, दिए गए निर्देशों का पालन करें Firebase सीएलआई इंस्टॉल करें.

अगर आपने सीएलआई को पहले ही इंस्टॉल कर लिया है, तो ऐप्लिकेशन को नए वर्शन में अपडेट करें.

चौथा चरण: अपना प्रोजेक्ट बनाना और सिंबल अपलोड करना

में, सिंबल वाले स्टैक ट्रेस दिखें.

iOS+ (Apple प्लैटफ़ॉर्म)

  1. बिल्ड सेटिंग डायलॉग से, अपने प्रोजेक्ट को Xcode वर्कस्पेस में एक्सपोर्ट करें.

  2. अपना ऐप्लिकेशन बनाएं.

    Apple प्लैटफ़ॉर्म के लिए, Firebase Unity Editor प्लगिन अपने-आप काम करता है यह आपके Xcode प्रोजेक्ट को कॉन्फ़िगर करके हर बिल्ड के लिए Firebase सर्वर पर Crashlytics-साथ काम करने वाली सिंबल फ़ाइल.

Android

  1. बिल्ड सेटिंग डायलॉग में जाकर, इनमें से कोई एक काम करें:

    • अपना प्रोजेक्ट बनाने के लिए, Android Studio प्रोजेक्ट में एक्सपोर्ट करें या

    • सीधे Unity Editor से अपना APK बनाएं.
      बिल्ड करने से पहले, पक्का करें कि बिल्ड सेटिंग डायलॉग में, symbols.zip बनाएं चेकबॉक्स पर सही का निशान लगा हो.

  2. बिल्ड पूरा होने के बाद, Crashlytics के साथ काम करने वाला सिंबल जनरेट करें फ़ाइल को डाउनलोड और उसे Firebase सर्वर पर अपलोड करने के लिए, Firebase सीएलआई निर्देश:

    firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/SYMBOLS
    • FIREBASE_APP_ID: आपका Firebase Android ऐप्लिकेशन आईडी (पैकेज का नाम नहीं)
      Firebase Android ऐप्लिकेशन आईडी का उदाहरण: 1:567383003300:android:17104a2ced0c9b9b

    • PATH/TO/SYMBOLS: सीएलआई से जनरेट की गई सिंबल फ़ाइल का पाथ

      • Android Studio प्रोजेक्ट में एक्सपोर्ट किया गया — PATH/TO/SYMBOLS, unityLibrary/symbols डायरेक्ट्री है. इसे Gradle या Android Studio की मदद से ऐप्लिकेशन बनाने के बाद, एक्सपोर्ट किए गए प्रोजेक्ट रूट में बनाया जाता है.

      • APK को सीधे Unity से बनाया गया — PATH/TO/SYMBOLS, प्रोजेक्ट की रूट डायरेक्ट्री में जनरेट की गई, ज़िप की गई सिंबल फ़ाइल का पाथ है. यह तब जनरेट होती है, जब आपका बिल्ड पूरा हो जाता है (उदाहरण के लिए: myproject/myapp-1.0-v100.symbols.zip).

    का उपयोग करने के लिए सिंबल फ़ाइल जनरेट करने और अपलोड करने के लिए, Firebase सीएलआई कमांड

    फ़्लैग करें जानकारी
    --generator=csym

    डिफ़ॉल्ट Breakpad जनरेटर के बजाय, लेगसी cSYM सिंबल फ़ाइल जनरेटर का इस्तेमाल करता है

    इस्तेमाल करने का सुझाव नहीं दिया जाता. हमारा सुझाव है कि आप डिफ़ॉल्ट ब्राउज़र का इस्तेमाल करें ब्रेकपैड सिंबल फ़ाइल जनरेटर.

    --generator=breakpad

    ब्रेकपैड सिंबल के फ़ाइल जनरेटर का इस्तेमाल करता है

    ध्यान दें कि सिंबल फ़ाइल जनरेट करने के लिए, डिफ़ॉल्ट रूप से Breakpad का इस्तेमाल किया जाता है. इस फ़्लैग का इस्तेमाल सिर्फ़ तब करें, जब आपने इसे जोड़ा हो symbolGenerator { csym() } कॉन्फ़िगर कर सकते हैं और आप इसका इस्तेमाल ब्रेकपैड का इस्तेमाल करें.

    --dry-run

    सिंबल फ़ाइलें जनरेट करता है, लेकिन उन्हें अपलोड नहीं करता

    यह फ़्लैग तब काम आता है, जब आपको भेजी गई फ़ाइलों के कॉन्टेंट की जांच करनी हो.

    --debug डीबग करने के बारे में ज़्यादा जानकारी देता है

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

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

  1. कोई मौजूदा GameObject ढूंढें, फिर उसमें इस स्क्रिप्ट को जोड़ें. यह आपके ऐप्लिकेशन चलाने के कुछ सेकंड बाद, स्क्रिप्ट टेस्ट क्रैश हो जाएगी.

    using System;
    using UnityEngine;
    
    public class CrashlyticsTester : MonoBehaviour {
    
        int updatesBeforeException;
    
        // Use this for initialization
        void Start () {
          updatesBeforeException = 0;
        }
    
        // Update is called once per frame
        void Update()
        {
            // Call the exception-throwing method here so that it's run
            // every frame update
            throwExceptionEvery60Updates();
        }
    
        // A method that tests your Crashlytics implementation by throwing an
        // exception every 60 frame updates. You should see reports in the
        // Firebase console a few minutes after running your app with this method.
        void throwExceptionEvery60Updates()
        {
            if (updatesBeforeException > 0)
            {
                updatesBeforeException--;
            }
            else
            {
                // Set the counter to 60 updates
                updatesBeforeException = 60;
    
                // Throw an exception to test your Crashlytics implementation
                throw new System.Exception("test exception please ignore");
            }
        }
    }
    
  2. अपना ऐप्लिकेशन बनाएं और बिल्ड पूरा होने के बाद सिंबल की जानकारी अपलोड करें.

    • iOS+: Firebase यूनिटी एडिटर प्लगिन आपकी सिंबल फ़ाइल अपलोड करने के लिए Xcode प्रोजेक्ट.

    • Android: IL2CPP का इस्तेमाल करने वाले Android ऐप्लिकेशन के लिए, अपनी सिंबल फ़ाइल अपलोड करने के लिए, Firebase CLI crashlytics:symbols:upload कमांड चलाएं.

  3. अपना ऐप्लिकेशन चलाएं. जब आपका ऐप्लिकेशन चलने लगे, तो डिवाइस लॉग देखें और इंतज़ार करें CrashlyticsTester से ट्रिगर होने वाला अपवाद.

    • iOS+: Xcode के निचले पैनल में लॉग देखें.

    • Android: टर्मिनल में यह निर्देश चलाकर लॉग देखें: adb logcat.

  4. टेस्ट क्रैश देखने के लिए, Firebase कंसोल के Crashlytics डैशबोर्ड पर जाएं.

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


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

अगले चरण

  • (सुझाया गया) IL2CPP का इस्तेमाल करने वाले Android ऐप्लिकेशन के लिए, इसके ज़रिए नेटिव मेमोरी गड़बड़ियों की वजह से होने वाले क्रैश को डीबग करने में मदद पाएं इकट्ठा किया जा रहा है GWP-ASan की रिपोर्ट. मेमोरी से जुड़ी ये गड़बड़ियां, आपके ऐप्लिकेशन में मेमोरी के खराब होने से जुड़ी हो सकती हैं. ऐप्लिकेशन में सुरक्षा से जुड़ी समस्याओं की मुख्य वजह यही होती है. डीबग करने की इस सुविधा का फ़ायदा पाने के लिए, पक्का करें कि आपका ऐप्लिकेशन Unity के लिए सबसे नए Crashlytics SDK टूल (v10.7.0+) का इस्तेमाल करता है और इसमें GWP-ASan को साफ़ तौर पर चालू किया गया (ज़रूरी है कि आप अपने Android ऐप्लिकेशन मेनिफ़ेस्ट में बदलाव करें).
  • Google Play के साथ इंटिग्रेट करें, ताकि आपके पास अपने Android ऐप्लिकेशन की क्रैश रिपोर्ट को Google Play ट्रैक के हिसाब से फ़िल्टर करने का विकल्प है. Crashlytics डैशबोर्ड. इससे आपको अपने डैशबोर्ड को खास बिल्ड पर बेहतर तरीके से फ़ोकस करने में मदद मिलती है.