Android की परफ़ॉर्मेंस मॉनिटर करने की सुविधा का इस्तेमाल शुरू करना

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

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

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

परफ़ॉर्मेंस मॉनिटर करने वाला SDK टूल जोड़ने के बाद, Firebase आपके ऐप्लिकेशन की स्क्रीन रेंडरिंग और उसके लाइफ़साइकल से जुड़ा डेटा अपने-आप इकट्ठा करना शुरू कर देता है. जैसे, ऐप्लिकेशन शुरू होने का समय. Firebase को नेटवर्क अनुरोधों को मॉनिटर करने की सुविधा चालू करने के लिए, आपको परफ़ॉर्मेंस मॉनिटरिंग Gradle प्लग इन भी जोड़ना होगा (अगला चरण).

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

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

    // Add the dependency for the Performance Monitoring library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-perf")
}

    Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase की Android लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

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

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

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

    dependencies {
    // Add the dependency for the Performance Monitoring library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-perf:21.0.1")
}
    क्या आपको Kotlin से जुड़े लाइब्रेरी मॉड्यूल की तलाश है? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java डेवलपर, दोनों मुख्य लाइब्रेरी मॉड्यूल पर निर्भर कर सकते हैं. ज़्यादा जानकारी के लिए, इस इनिशिएटिव के बारे में अक्सर पूछे जाने वाले सवाल देखें.

  2. अपने ऐप्लिकेशन को फिर से कंपाइल करें.

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

परफ़ॉर्मेंस मॉनिटर करने वाले Gradle प्लग इन जोड़ने के बाद, Firebase एचटीटीपी/S नेटवर्क अनुरोधों के लिए अपने-आप डेटा इकट्ठा करना शुरू कर देता है. इस प्लग इन की मदद से @AddTrace एनोटेशन का इस्तेमाल करके, कस्टम कोड ट्रेस भी तैयार किए जा सकते हैं.

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

    Kotlin 

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id("com.android.application") version "7.3.0" apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id("com.google.gms.google-services") version "4.4.2" apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf") version "1.4.2" apply false
}

    Groovy 

    plugins {
    // To benefit from the latest Performance Monitoring plugin features,
    // update your Android Gradle plugin dependency to at least v3.4.0
    id 'com.android.application' version '7.3.0' apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id 'com.google.gms.google-services' version '4.4.2' apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
}

  2. अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर, <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.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 Performance Monitoring Gradle plugin
    id("com.google.firebase.firebase-perf")
    ...
}

    Groovy 

    plugins {
    id 'com.android.application'

    // Make sure that you have the Google services Gradle plugin
    id 'com.google.gms.google-services'

    // Add the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf'
    ...
}

  3. अपने ऐप्लिकेशन को फिर से कंपाइल करें.

तीसरा चरण: शुरुआती डेटा दिखाने के लिए परफ़ॉर्मेंस इवेंट जनरेट करना

जब ऐप्लिकेशन में SDK टूल जोड़ दिया जाता है, तो Firebase इवेंट को प्रोसेस करना शुरू कर देता है. अगर अब भी स्थानीय तौर पर डेटा डेवलप किया जा रहा है, तो अपने ऐप्लिकेशन से इंटरैक्ट करके, शुरुआती डेटा कलेक्शन और प्रोसेसिंग के लिए इवेंट जनरेट करें.

  1. अपने ऐप्लिकेशन को बैकग्राउंड और फ़ोरग्राउंड के बीच कई बार स्विच करके, अलग-अलग स्क्रीन पर नेविगेट करके और/या नेटवर्क के अनुरोधों को ट्रिगर करके, अपने ऐप्लिकेशन से इंटरैक्ट करके इवेंट जनरेट करें.

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

    अगर आपको अपना शुरुआती डेटा नहीं दिखता है, तो समस्या हल करने की सलाह देखें.

चौथा चरण: (ज़रूरी नहीं) परफ़ॉर्मेंस इवेंट के लॉग मैसेज देखें

  1. अपने ऐप्लिकेशन की AndroidManifest.xml फ़ाइल में <meta-data> एलिमेंट जोड़कर, परफ़ॉर्मेंस मॉनिटर करने के लिए बिल्ड के समय डीबग लॉग करने की सुविधा चालू करें. जैसे:

    <application>
    <meta-data
      android:name="firebase_performance_logcat_enabled"
      android:value="true" />
</application>

  2. गड़बड़ी के किसी भी मैसेज के लिए अपने लॉग मैसेज देखें.

  3. परफ़ॉर्मेंस मॉनिटर करने की सुविधा, अपने लॉग मैसेज को FirebasePerformance के साथ टैग करती है. लॉगकैट फ़िल्टर का इस्तेमाल करके, खास तौर पर अवधि ट्रेस और एचटीटीपी/S नेटवर्क का अनुरोध लॉग देखने की सुविधा मिलती है. इसके लिए, यह निर्देश दिया जाता है:

    adb logcat -s FirebasePerformance

  4. इस तरह के लॉग देखें. इनसे पता चलता है कि परफ़ॉर्मेंस मॉनिटर करने की सुविधा, परफ़ॉर्मेंस इवेंट को लॉग कर रही है:

    • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL

  5. Firebase कंसोल में अपना डेटा देखने के लिए, यूआरएल पर क्लिक करें. डैशबोर्ड में डेटा को अपडेट होने में कुछ समय लग सकता है.

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

पांचवां चरण: (ज़रूरी नहीं) किसी कोड के लिए, अपने हिसाब से मॉनिटरिंग की सुविधा चालू करना

अपने ऐप्लिकेशन में किसी खास कोड से जुड़े परफ़ॉर्मेंस डेटा की निगरानी करने के लिए, कस्टम कोड ट्रेस इंस्टॉल किए जा सकते हैं.

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

अपने कोड में, परफ़ॉर्मेंस मॉनिटर करने वाले SDK टूल से मिले एपीआई का इस्तेमाल करके, कस्टम कोड ट्रेस के शुरू और आखिरी हिस्से को तय किया जाता है. साथ ही, अपनी पसंद की कोई भी कस्टम मेट्रिक जोड़ी जाती है. Android ऐप्लिकेशन के लिए, @AddTrace एनोटेशन का इस्तेमाल करके, खास तरीकों की अवधि पर नज़र रखी जा सकती है.

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

छठा चरण: अपना ऐप्लिकेशन डिप्लॉय करें और फिर नतीजों की समीक्षा करें

एक या उससे ज़्यादा टेस्ट डिवाइसों का इस्तेमाल करके परफ़ॉर्मेंस मॉनिटर करने की सुविधा की पुष्टि करने के बाद, उपयोगकर्ताओं के लिए अपने ऐप्लिकेशन के अपडेट किए गए वर्शन को डिप्लॉय किया जा सकता है.

Firebase कंसोल के परफ़ॉर्मेंस डैशबोर्ड में जाकर, परफ़ॉर्मेंस डेटा की निगरानी की जा सकती है.

ऐसी समस्याएं जो पहले भी आ चुकी हैं

  • परफ़ॉर्मेंस मॉनिटर करने वाले ग्रेडल प्लगिन के वर्शन 1.1.0 की वजह से, Guava डिपेंडेंसी में अंतर हो सकता है. इसकी वजह से यह गड़बड़ी हो सकती है:

    Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
> com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;

    अगर आपको यह गड़बड़ी दिखती है, तो इनमें से कोई एक तरीका अपनाएं:

    • परफ़ॉर्मेंस मॉनिटर करने वाले प्लग इन को v1.1.1 या इसके बाद वाले वर्शन में अपग्रेड करें. सबसे नया प्लगिन 1.4.2 है.

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

      Kotlin 

      buildscript {
  // ...

  dependencies {
    // ...

    // Replace the standard Performance Monitoring plugin dependency line, as follows:
    classpath("com.google.firebase:perf-plugin:1.1.0") {
        exclude(group = "com.google.guava", module = "guava-jdk5")
    }
  }
}

      Groovy 

      buildscript {
  // ...

  dependencies {
    // ...

    // Replace the standard Performance Monitoring plugin dependency line, as follows:
    classpath('com.google.firebase:perf-plugin:1.1.0') {
        exclude group: 'com.google.guava', module: 'guava-jdk5'
    }
  }
}

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

  • परफ़ॉर्मेंस मॉनिटर करने की सुविधा, कई प्रोसेस वाले Android ऐप्लिकेशन की मुख्य प्रोसेस के साथ ही काम करती है.

अगले चरण