Mulai dengan Pemantauan Kinerja untuk Android

Sebelum kamu memulai

Jika Anda belum melakukannya, tambahkan Firebase ke proyek Android Anda .

Langkah 1 : Tambahkan Performance Monitoring SDK ke aplikasi Anda

Setelah Anda menambahkan Performance Monitoring SDK, Firebase otomatis mulai mengumpulkan data untuk perenderan layar aplikasi Anda dan data yang terkait dengan siklus hidup aplikasi Anda (seperti waktu mulai aplikasi ). Agar Firebase dapat memantau permintaan jaringan, Anda juga harus menambahkan plugin Performance Monitoring Gradle (langkah berikutnya).

1. Dalam file Gradle modul (level aplikasi) Anda (biasanya <project>/<app-module>/build.gradle ), tambahkan dependensi untuk library Android Performance Monitoring. Kami merekomendasikan penggunaan Firebase Android BoM untuk mengontrol pembuatan versi library.

   Kotlin+KTX

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:31.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-ktx'
   }
   

   Dengan menggunakan Firebase Android BoM , aplikasi Anda akan selalu menggunakan versi pustaka Android Firebase yang kompatibel.

   (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

   Jika Anda memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi pustaka Firebase di baris dependensinya.

   Perhatikan bahwa jika Anda menggunakan beberapa pustaka Firebase di aplikasi Anda, kami sangat menyarankan penggunaan BoM untuk mengelola versi pustaka, yang memastikan bahwa semua versi kompatibel.

   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-ktx:20.3.1'
   }
   

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:31.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'
   }
   

   Dengan menggunakan Firebase Android BoM , aplikasi Anda akan selalu menggunakan versi pustaka Android Firebase yang kompatibel.

   (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

   Jika Anda memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi pustaka Firebase di baris dependensinya.

   Perhatikan bahwa jika Anda menggunakan beberapa pustaka Firebase di aplikasi Anda, kami sangat menyarankan penggunaan BoM untuk mengelola versi pustaka, yang memastikan bahwa semua versi kompatibel.

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

2. Kompilasi ulang aplikasi Anda.

Catatan: Saat Anda menambahkan Performance Monitoring SDK ke aplikasi Anda, Remote Config SDK disertakan sebagai dependensi. Jika Anda sudah menggunakan Remote Config, Anda tidak akan melihat perbedaan apa pun. Namun, jika Anda baru mengenal Remote Config, jelajahi dokumentasi Remote Config untuk mempelajari lebih lanjut berbagai fitur yang dapat Anda akses di aplikasi Anda.

Langkah 2 : Tambahkan plugin Gradle Performance Monitoring ke aplikasi Anda

Setelah Anda menambahkan plugin Performance Monitoring Gradle, Firebase otomatis mulai mengumpulkan data untuk permintaan jaringan HTTP/S . Plugin ini juga memungkinkan Anda untuk melengkapi pelacakan kode khusus menggunakan anotasi @AddTrace .

Cara kerja plugin Pemantauan Kinerja

Sebelum kode Anda dikonversi ke file DEX, plugin Performance Monitoring menggunakan Transform API dan framework instrumentasi bytecode ASM untuk mengunjungi file kelas terkompilasi aplikasi Anda dan melengkapi kode (untuk mengukur performa). Waktu yang diperlukan untuk melengkapi kode Anda sangat bergantung pada jumlah dan ukuran kelas Anda.

Jika aplikasi Anda membutuhkan lebih banyak waktu untuk dikompilasi daripada yang Anda inginkan, pertimbangkan opsi berikut:

• Nonaktifkan plugin Performance Monitoring untuk build debug Anda pada waktu kompilasi
• Modularisasikan kode Anda untuk mengoptimalkan kecepatan build Anda

1. Di file Gradle level root (level proyek) Anda ( <project>/build.gradle ), tambahkan plugin Performance Monitoring Gradle sebagai dependensi buildscript:

   buildscript {
       repositories {
         // Make sure that you have the following two repositories
         google()  // Google's Maven repository
         mavenCentral()  // Maven Central repository
       }
   
       dependencies {
           ...
           // To benefit from the latest Performance Monitoring plugin features,
           // update your Android Gradle plugin dependency to at least v3.4.0
           classpath 'com.android.tools.build:gradle:7.2.0'
   
           // Make sure that you have the Google services Gradle plugin dependency
           classpath 'com.google.gms:google-services:4.3.15'
   
           // Add the dependency for the Performance Monitoring Gradle plugin
           classpath 'com.google.firebase:perf-plugin:1.4.2'
       }
   }

2. Dalam file Gradle modul (level aplikasi) Anda (biasanya <project>/<app-module>/build.gradle ), tambahkan plugin Gradle Pemantauan Kinerja:

   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. Kompilasi ulang aplikasi Anda.

Langkah 3 : Hasilkan peristiwa kinerja untuk tampilan data awal

Firebase mulai memproses peristiwa saat Anda berhasil menambahkan SDK ke aplikasi Anda. Jika Anda masih mengembangkan secara lokal, berinteraksilah dengan aplikasi Anda untuk menghasilkan peristiwa untuk pengumpulan dan pemrosesan data awal.

Catatan: Performance Monitoring SDK mengelompokkan peristiwa secara lokal lalu mengirimkannya ke Firebase secara berkala (setiap 30 detik). Jadi, ada penundaan antara interaksi aplikasi dan saat Firebase menerima informasi kejadian dari aplikasi Anda.

1. Hasilkan peristiwa dengan mengalihkan aplikasi Anda antara latar belakang dan latar depan beberapa kali, berinteraksi dengan aplikasi Anda dengan menavigasi melintasi layar, dan/atau memicu permintaan jaringan.

2. Buka dasbor Performa konsol Firebase. Anda akan melihat tampilan data awal Anda dalam beberapa menit.

   Jika Anda tidak melihat tampilan data awal Anda, tinjau tips pemecahan masalah .

Langkah 4 : (Opsional) Lihat pesan log untuk peristiwa kinerja

1. Aktifkan logging debug untuk Performance Monitoring pada waktu pembuatan dengan menambahkan elemen <meta-data> ke file AndroidManifest.xml aplikasi Anda, seperti:

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

2. Periksa pesan log Anda untuk setiap pesan kesalahan.

3. Performance Monitoring menandai pesan lognya dengan FirebasePerformance . Dengan menggunakan pemfilteran logcat, Anda dapat secara khusus melihat pelacakan durasi dan pembuatan log permintaan jaringan HTTP/S dengan menjalankan perintah berikut:

   adb logcat -s FirebasePerformance

4. Periksa jenis log berikut yang menunjukkan bahwa Performance Monitoring mencatat peristiwa kinerja:

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

5. Klik URL untuk melihat data Anda di konsol Firebase. Mungkin perlu beberapa saat untuk memperbarui data di dasbor.

Jika aplikasi Anda tidak mencatat peristiwa kinerja, tinjau tips pemecahan masalah .

Langkah 5 : (Opsional) Tambahkan pemantauan khusus untuk kode tertentu

Untuk memantau data kinerja yang terkait dengan kode tertentu di aplikasi, Anda dapat melengkapi pelacakan kode khusus .

Dengan pelacakan kode khusus, Anda dapat mengukur berapa lama waktu yang dibutuhkan aplikasi untuk menyelesaikan tugas atau kumpulan tugas tertentu, seperti memuat kumpulan gambar atau membuat kueri database Anda. Metrik default untuk pelacakan kode khusus adalah durasinya, tetapi Anda juga dapat menambahkan metrik khusus, seperti cache hits dan peringatan memori.

Dalam kode Anda, Anda menentukan awal dan akhir pelacakan kode khusus (dan menambahkan metrik khusus yang diinginkan) menggunakan API yang disediakan oleh Performance Monitoring SDK. Untuk aplikasi Android, Anda juga bisa memantau durasi metode tertentu menggunakan anotasi @AddTrace .

Kunjungi Tambahkan pemantauan untuk kode tertentu guna mempelajari lebih lanjut tentang fitur ini dan cara menambahkannya ke aplikasi Anda.

Langkah 6 : Terapkan aplikasi Anda lalu tinjau hasilnya

Setelah Anda memvalidasi Performance Monitoring menggunakan satu atau beberapa perangkat pengujian, Anda dapat menerapkan versi terbaru aplikasi Anda kepada pengguna.

Anda dapat memantau data performa di dasbor Performa Firebase console.

Masalah Dikenal

• Plugin Performance Monitoring Gradle v1.1.0 dapat menyebabkan ketidakcocokan dalam dependensi Guava, yang mengakibatkan error berikut:

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

  Jika Anda melihat kesalahan ini, Anda dapat:

  • Tingkatkan plugin Performance Monitoring ke v1.1.1 atau lebih baru (yang terbaru adalah v1.4.2).

  • Ganti baris dependensi plugin Performance Monitoring di file Gradle level root (level proyek) Anda ( build.gradle ), sebagai berikut:

    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 melaporkan ukuran payload total untuk permintaan jaringan HTTP berdasarkan nilai yang ditetapkan di header panjang konten HTTP. Nilai ini mungkin tidak selalu akurat.

• Pemantauan Kinerja hanya mendukung proses utama dalam aplikasi Android multi-proses.

Langkah selanjutnya

• Tinjau dan jalankan contoh kode Android Performance Monitoring di GitHub .

• Pelajari lebih lanjut tentang data yang dikumpulkan secara otomatis oleh Performance Monitoring:

  • Data yang terkait dengan siklus hidup aplikasi Anda, seperti waktu mulai aplikasi
  • Data untuk perenderan layar di aplikasi Anda
  • Data untuk permintaan jaringan HTTP/S yang dikeluarkan oleh aplikasi Anda

• Lihat, lacak, dan filter data performa Anda di Firebase console.

• Tambahkan pemantauan untuk tugas atau alur kerja tertentu di aplikasi Anda dengan memperlengkapi pelacakan kode khusus .

• Gunakan atribut untuk memfilter data performa .