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

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

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

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

Performance Monitoring SDK टूल जोड़ने के बाद, Firebase आपके ऐप्लिकेशन के स्क्रीन रेंडरिंग का डेटा अपने-आप इकट्ठा करना शुरू कर देता है. साथ ही, आपके ऐप्लिकेशन के लाइफ़साइकल से जुड़ा डेटा भी इकट्ठा करता है. जैसे, ऐप्लिकेशन शुरू होने का समय. नेटवर्क अनुरोधों को मॉनिटर करने के लिए 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:34.2.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:22.0.1")
   }

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

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

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

Performance Monitoring प्लगिन कैसे काम करता है

आपके कोड को DEX फ़ाइलों में बदलने से पहले, Performance Monitoring प्लगिन, Transform API और ASM bytecode instrumentation framework का इस्तेमाल करता है. इससे, आपके ऐप्लिकेशन की कंपाइल की गई क्लास फ़ाइलों को ऐक्सेस किया जा सकता है और कोड को इंस्ट्रुमेंट किया जा सकता है, ताकि परफ़ॉर्मेंस का आकलन किया जा सके. आपके कोड को इंस्ट्रूमेंट करने में लगने वाला समय, आपकी क्लास की संख्या और साइज़ पर निर्भर करता है.

अगर आपके ऐप्लिकेशन को कंपाइल होने में ज़्यादा समय लगता है, तो इन विकल्पों को आज़माएं:

• कंपाइल टाइम पर, अपनी डीबग बिल्ड के लिए Performance Monitoring प्लगिन बंद करें
• अपने कोड को मॉड्यूल में बांटें, ताकि बिल्ड करने की स्पीड को ऑप्टिमाइज़ किया जा सके

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.3" apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id("com.google.firebase.firebase-perf") version "2.0.1" 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.3' apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id 'com.google.firebase.firebase-perf' version '2.0.1' 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. बिल्ड के समय Performance Monitoring के लिए डीबग लॉगिंग चालू करें. इसके लिए, अपने ऐप्लिकेशन की AndroidManifest.xml फ़ाइल में <meta-data> एलिमेंट जोड़ें. जैसे:

   <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 annotation का इस्तेमाल करके, किसी खास तरीके की अवधि को भी मॉनिटर किया जा सकता है.

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

छठा चरण: ऐप्लिकेशन को डिप्लॉय करें. इसके बाद, नतीजों की समीक्षा करें

एक या उससे ज़्यादा टेस्ट डिवाइसों का इस्तेमाल करके 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 या उसके बाद के वर्शन पर अपग्रेड करें. सबसे नया वर्शन v2.0.1 है.

  • अपनी रूट-लेवल (प्रोजेक्ट-लेवल) 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 ऐप्लिकेशन में सिर्फ़ मुख्य प्रोसेस के साथ काम करती है.

अगले चरण

• Performance Monitoring Android कोड के सैंपल को GitHub पर देखें और चलाएं.

• Performance Monitoring के ज़रिए अपने-आप इकट्ठा होने वाले डेटा के बारे में ज़्यादा जानें:

  • आपके ऐप्लिकेशन के लाइफ़साइकल से जुड़ा डेटा, जैसे कि ऐप्लिकेशन शुरू होने का समय
  • आपके ऐप्लिकेशन में स्क्रीन रेंडरिंग के लिए डेटा
  • आपके ऐप्लिकेशन से जारी किए गए एचटीटीपी/एस नेटवर्क अनुरोधों का डेटा

• Firebase कंसोल में, अपनी परफ़ॉर्मेंस का डेटा देखें, ट्रैक करें, और फ़िल्टर करें.

• अपने ऐप्लिकेशन में कुछ टास्क या वर्कफ़्लो के लिए मॉनिटरिंग की सुविधा जोड़ें. इसके लिए, कस्टम कोड ट्रेस को इंस्ट्रुमेंट करें.

• परफ़ॉर्मेंस डेटा को फ़िल्टर करने के लिए एट्रिब्यूट इस्तेमाल करें.