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

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

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

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

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

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

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

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

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

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

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

  1. अपनी रूट-लेवल (प्रोजेक्ट-लेवल) Gradle फ़ाइल (<project>/build.gradle.kts या <project>/build.gradle) में, Performance Monitoring 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) में, Performance Monitoring 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> एलिमेंट जोड़कर, बिल्ड के समय Performance Monitoring के लिए डीबग लॉगिंग चालू करें. जैसे:

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

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

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

    adb logcat -s FirebasePerformance

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

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

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

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

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

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

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

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

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

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

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

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

ज्ञात समस्याएं

  • Performance Monitoring Gradle प्लग इन v1.1.0 क�� वजह से, Guava की डिपेंडेंसी में मैच न होने की समस्या हो सकती है. इसकी वजह से, यह गड़बड़ी दिख सकती है:

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

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

    • Performance Monitoring प्लग इन को v1.1.1 या इसके बाद के वर्शन पर अपग्रेड करें. सबसे नया वर्शन v1.4.2 है.

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

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

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

  • Performance Monitoring सिर्फ़ एक से ज़्यादा प्रोसेस वाले Android ऐप्लिकेशन की मुख्य प्रोसेस के साथ काम करता है.

अगले चरण