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 टूल जोड़ना

ध्यान दें कि जब आपने अपने Unity प्रोजेक्ट को Firebase प्रोजेक्ट के साथ रजिस्टर किया था, तो हो सकता है कि आपने पहले ही 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 प्रोजेक्ट को अपने-आप कॉन्फ़िगर करता है, ताकि हर बिल्ड के लिए Crashlytics के साथ काम करने वाली सिंबल फ़ाइल जनरेट की जा सके और उसे Firebase सर्वर पर अपलोड किया जा सके.

Android

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

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

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

  2. बिल्ड पूरा होने के बाद, Crashlytics के साथ काम करने वाली सिंबल फ़ाइल जनरेट करें. इसके बाद, Firebase CLI कमांड चलाकर, उसे 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 सिंबल फ़ाइल जनरेटर का इस्तेमाल करता है

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

    --generator=breakpad

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

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

    --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 Unity Editor प्लग इन, आपकी सिंबल फ़ाइल को अपलोड करने के लिए, आपके 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 टूल के सबसे नए वर्शन (10.7.0+) का इस्तेमाल करता हो. साथ ही, GWP-ASan की सुविधा साफ़ तौर पर चालू हो. इसके लिए, आपको अपने Android ऐप्लिकेशन मेनिफ़ेस्ट में बदलाव करना होगा.
  • Google Play के साथ इंटिग्रेट करें, ताकि आप अपने Android ऐप्लिकेशन की क्रैश रिपोर्ट को Google Play ट्रैक के हिसाब से, सीधे Crashlytics डैशबोर्ड में फ़िल्टर कर सकें. इससे, अपने डैशबोर्ड को खास बिल्ड पर बेहतर तरीके से फ़ोकस किया जा सकता है.