השבתת מעקב אחר ביצועים ב-Firebase


במהלך הפיתוח והבדיקה של האפליקציה, יכול להיות שיהיה שימושי להשבית את Performance Monitoring.

לדוגמה, כשמשביתים את Performance Monitoring במהלך תהליך ה-build של האפליקציה, אפשר:

  • משביתים פונקציות מסוימות של Performance Monitoring (כמו אלה שסופקו על ידי הפלאגין Performance Monitoring Gradle) בגרסאות ה-build לניפוי באגים, אבל מפעילים מחדש את הפונקציות בגרסאות ה-build לפריסה.

  • משביתים את Performance Monitoring בזמן פיתוח האפליקציה, אבל מאפשרים לאפליקציה להפעיל אותו מחדש במהלך זמן הריצה.

  • משביתים את Performance Monitoring בזמן פיתוח האפליקציה, ולא מאפשרים לאפליקציה להפעיל אותו מחדש בזמן הריצה.

אפשר גם לפתח את האפליקציה עם Performance Monitoring מופעל, אבל להשתמש ב-Firebase Remote Config כדי לקבל גמישות להשבית (ולפעול מחדש) את Performance Monitoring באפליקציה בסביבת הייצור. באמצעות האפשרות הזו, אפשר גם להגדיר את האפליקציה כך שתאפשר למשתמשים להביע הסכמה או סירוב לשימוש ב-Performance Monitoring.

השבתת Performance Monitoring במהלך תהליך ה-build של האפליקציה

אפשר להשבית את Performance Monitoring במהלך תהליך ה-build על ידי השבתה של הפלאגין Performance Monitoring ל-Gradle ו/או על ידי השבתה של ספריית Android‏ Performance Monitoring.

במהלך הפיתוח וניפוי הבאגים, כדאי להשבית את הפלאגין כי הכלי למדידת ביצועים של הפלאגין יכול להאריך את זמן ה-build. עם זאת, מומלץ להשאיר את הספרייה מופעלת כדי שעדיין תוכלו להציג את נתוני הביצועים ממעקבים אחרי הפעלת האפליקציה, אחרי האפליקציה בחזית וגם אחרי האפליקציה ברקע, וגם את מעקבים אחרי קוד מותאם אישית באפליקציה.

השבתת הפלאגין Performance Monitoring של Gradle

אפשר להשבית את הפלאגין Performance Monitoring על ידי הוספת הדגל instrumentationEnabled באמצעות האפשרויות הבאות:

  • Extension Property – השבתת הפלאגין עבור וריאנט build ספציפי בזמן הידור

  • מאפיין פרויקט – משבית את הפלאגין בכל הווריאציות של ה-build בזמן הידור

השבתת הפלאגין באמצעות דגל של נכס תוסף

באמצעות דגל Extensions Property, אפשר להשבית את הפלאגין Performance Monitoring עבור וריאנט build ספציפי בזמן הידור.

  1. בקובץ Gradle ברמת הבסיס (ברמת הפרויקט) (<project>/build.gradle.kts או <project>/build.gradle), מוודאים שהגרסה של התלות ב-Android Gradle Plugin היא 3.4.0 ואילך.

    בגרסאות קודמות של Android Gradle Plugin, עדיין אפשר להשבית את הפלאגין Performance Monitoring לגרסה ספציפית של build, אבל הזמן שהפלאגין צורך בזמן ה-build לא יוסר לגמרי לגרסה הזו.

  2. מוסיפים את הדגל הבא לקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle), ואז מגדירים אותו כ-false כדי להשבית את הפלאגין Performance Monitoring.

    Kotlin 

    import com.google.firebase.perf.plugin.FirebasePerfExtension

// ...

android {
  // ...
  buildTypes {
    getByName("debug") {
      configure<FirebasePerfExtension> {
        // Set this flag to 'false' to disable @AddTrace annotation processing and
        // automatic monitoring of HTTP/S network requests
        // for a specific build variant at compile time.
        setInstrumentationEnabled(false)
      }
    }
  }
}

    Groovy 

    android {
  // ...
  buildTypes {
    debug {
      FirebasePerformance {
        // Set this flag to 'false' to disable @AddTrace annotation processing and
        // automatic monitoring of HTTP/S network requests
        // for a specific build variant at compile time.
        instrumentationEnabled false
      }
    }
  }
}

השבתת הפלאגין באמצעות דגל של נכס פרויקט

באמצעות דגל Project Property, אפשר להשבית את הפלאגין Performance Monitoring לכל הווריאנטים של ה-build בזמן הידור.

מוסיפים את הדגל הבא לקובץ gradle.properties ומגדירים אותו לערך false כדי להשבית את הפלאגין Performance Monitoring.

// ...

// Set this flag to 'false' to disable @AddTrace annotation processing and
// automatic monitoring of HTTP/S network requests
// for all build variants at compile time.
firebasePerformanceInstrumentationEnabled=false

השבתת ספריית Android‏ Performance Monitoring

אם משביתים את ספריית Performance Monitoring בזמן הידור, אפשר לבחור אם לאפשר לאפליקציה להפעיל את הספרייה בזמן הריצה.

להשבית את הספרייה בזמן הידור, אבל לאפשר לאפליקציה להפעיל אותה בזמן הריצה

מוסיפים את הרכיב <meta-data> הבא לקובץ AndroidManifest.xml של האפליקציה:

  <application>
    <meta-data
      android:name="firebase_performance_collection_enabled"
      android:value="false" />
  </application>

להשבית את הספרייה בזמן הידור, אבל לא לאפשר לאפליקציה להפעיל אותה בזמן הריצה

מוסיפים את הרכיב <meta-data> הבא לקובץ AndroidManifest.xml של האפליקציה:

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

השבתת האפליקציה בזמן הריצה באמצעות Remote Config

Firebase Remote Config מאפשר לבצע שינויים בהתנהגות ובמראה של האפליקציה, כך שהוא מספק דרך אידיאלית להשבית את Performance Monitoring במכונות הפרוסות של האפליקציה.

כדי להשבית את איסוף הנתונים של Performance Monitoring בפעם הבאה שהאפליקציה ל-Android תופעל, משתמשים בקוד לדוגמה שמופיע בהמשך. למידע נוסף על השימוש ב-Remote Config באפליקציה ל-Android, ראו שימוש ב-Firebase Remote Config ב-Android.

  1. מוודאים ש-Remote Config נמצא בקטע dependencies בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle):

    Kotlin+KTX 

      implementation("com.google.firebase:firebase-config-ktx:22.0.1")

    Java 

      implementation("com.google.firebase:firebase-config:22.0.1")

  2. מגדירים את Remote Config ומשביתים את Performance Monitoring אם הערך של perf_disable מוגדר בתור true:

    Kotlin+KTX 

    // Setup remote config
val config = Firebase.remoteConfig

// You can uncomment the following two statements to permit more fetches when
// validating your app, but you should comment out or delete these lines before
// distributing your app in production.
// val configSettings = remoteConfigSettings {
//     minimumFetchIntervalInSeconds = 3600
// }
// config.setConfigSettingsAsync(configSettings)
// Load in-app defaults from an XML file that sets perf_disable to false until you update
// values in the Firebase Console

// Observe the remote config parameter "perf_disable" and disable Performance Monitoring if true
config.setDefaultsAsync(R.xml.remote_config_defaults)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            Firebase.performance.isPerformanceCollectionEnabled = !config.getBoolean("perf_disable")
        } else {
            // An error occurred while setting default parameters
        }
    }
    MainActivity.kt

    Java 

    // Setup remote config
final FirebaseRemoteConfig config = FirebaseRemoteConfig.getInstance();

// You can uncomment the following two statements to permit more fetches when
// validating your app, but you should comment out or delete these lines before
// distributing your app in production.
// FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
//       .setMinimumFetchIntervalInSeconds(3600)
//       .build();
// config.setConfigSettingsAsync(configSettings);
// Load in-app defaults from an XML file that sets perf_disable to false until you update
// values in the Firebase Console

//Observe the remote config parameter "perf_disable" and disable Performance Monitoring if true
config.setDefaultsAsync(R.xml.remote_config_defaults)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                if (task.isSuccessful()) {
                    if (config.getBoolean("perf_disable")) {
                        FirebasePerformance.getInstance().setPerformanceCollectionEnabled(false);
                    } else {
                        FirebasePerformance.getInstance().setPerformanceCollectionEnabled(true);
                    }
                } else {
                    // An error occurred while setting default parameters
                }
            }
        });
    MainActivity.java

  3. מוסיפים את הקוד הבא ל-MainActivity.java כדי לאחזר ולהפעיל את הערכים של Remote Config:

    Kotlin+KTX 

    // Remote Config fetches and activates parameter values from the service
val config = Firebase.remoteConfig
config.fetch(3600)
    .continueWithTask { task ->
        if (!task.isSuccessful) {
            task.exception?.let {
                throw it
            }
        }
        config.activate()
    }
    .addOnCompleteListener(this) { task ->
        if (task.isSuccessful) {
            // Parameter values successfully activated
            // ...
        } else {
            // Handle errors
        }
    }
    MainActivity.kt

    Java 

    //Remote Config fetches and activates parameter values from the service
final FirebaseRemoteConfig config = FirebaseRemoteConfig.getInstance();
config.fetch(3600)
        .continueWithTask(new Continuation<Void, Task<Boolean>>() {
            @Override
            public Task<Boolean> then(@NonNull Task<Void> task) throws Exception {
                if (!task.isSuccessful()) {
                    throw task.getException();
                }
                return config.activate();
            }
        })
        .addOnCompleteListener(new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                if (task.isSuccessful()) {
                    // Parameter values successfully activated
                    // ...
                } else {
                    // Handle errors
                }
            }
        });
    MainActivity.java

  4. כדי להשבית את Performance Monitoring במסוף Firebase, יוצרים פרמטר perf_disable בפרויקט של האפליקציה ומגדירים את הערך שלו כ-true.

    השינוי הזה יגרום לקריאות ל-SDK של Performance Monitoring מסוג 'ללא פעולה' (NOOP), וכך יבטל את ההשפעה המשמעותית של השימוש ב-SDK של Performance Monitoring באפליקציה על ביצועי האפליקציה.

    אם מגדירים את הערך של perf_disable ל-false, האפשרות Performance Monitoring תישאר מופעלת.