Mengukur waktu pemuatan dan rendering layar dengan Firebase Performance Monitoring

1. Pengantar

Terakhir diperbarui: 11-03-2021

Mengapa kita perlu mengukur performa Tampilan?

Tampilan adalah bagian penting dari aplikasi Android yang secara langsung memengaruhi pengalaman pengguna. Misalnya, Aktivitas atau Fragmen Anda berisi UI yang menyimpan komponen Tampilan yang berinteraksi dengan pengguna. Pengguna tidak dapat melihat seluruh konten UI hingga benar-benar digambar di layar. Layar yang lambat dan berhenti akan langsung mengganggu interaksi pengguna dengan aplikasi Anda dan menciptakan pengalaman pengguna yang buruk.

Bukankah Firebase Performance Monitoring menyediakan metrik performa ini secara langsung?

Firebase Performance Monitoring otomatis menangkap beberapa data performa siap pakai, seperti waktu mulai aplikasi (yaitu, waktu pemuatan untuk Aktivitas pertama saja) dan performa rendering layar (yaitu, periode lambat dan periode frozen untuk Activity, tetapi tidak untuk Fragment). Namun, aplikasi industri biasanya tidak memiliki banyak Activity, melainkan satu Activity dan beberapa Fragment. Selain itu, banyak aplikasi biasanya menerapkan Tampilan Kustom sendiri untuk kasus penggunaan yang lebih kompleks. Jadi, sering kali ada gunanya memahami cara mengukur waktu pemuatan dan performa rendering layar untuk Activity dan Fragment dengan menginstrumentasikan trace kode kustom di aplikasi Anda. Anda dapat memperluas codelab ini dengan mudah untuk mengukur performa komponen Tampilan Kustom.

Yang akan Anda pelajari

• Cara menambahkan Firebase Performance Monitoring ke aplikasi Android
• Memahami pemuatan Aktivitas atau Fragmen
• Cara menginstrumentasikan trace kode kustom untuk mengukur waktu pemuatan Aktivitas atau Fragmen
• Memahami Rendering Layar dan apa yang dimaksud dengan frame Lambat/Beku
• Cara menginstrumentasikan trace kode kustom dengan metrik untuk merekam layar Lambat/Beku
• Cara melihat metrik yang dikumpulkan di Firebase console

Yang Anda butuhkan

• Android Studio 4.0 atau yang lebih baru
• Perangkat/emulator Android
• Java versi 8 atau yang lebih baru

2. Mempersiapkan

Mendapatkan kode

Jalankan perintah berikut untuk meng-clone kode contoh untuk codelab ini. Tindakan ini akan membuat folder dengan nama codelab-measure-android-view-performance di komputer Anda:

$ git clone https://github.com/FirebaseExtended/codelab-measure-android-view-performance.git
$ cd codelab-measure-android-view-performance

Jika tidak memiliki git di komputer, Anda juga dapat mendownload kodenya langsung dari GitHub.

Impor project measure-view-performance-start ke Android Studio. Anda mungkin akan melihat beberapa error kompilasi atau mungkin peringatan tentang file google-services.json yang hilang. Kami akan memperbaikinya di bagian berikutnya pada langkah ini.

Dalam codelab ini, kita akan menggunakan plugin Firebase Assistant untuk mendaftarkan aplikasi Android ke project Firebase dan menambahkan file konfigurasi, plugin, serta dependensi Firebase yang diperlukan ke project Android — semuanya dari dalam Android Studio.

Menghubungkan aplikasi ke Firebase

1. Buka Android Studio/Help > Check for updates untuk memastikan Anda menggunakan Android Studio dan Firebase Assistant versi terbaru.
2. Pilih Tools > Firebase untuk membuka panel Assistant.

3. Pilih Performance Monitoring untuk ditambahkan ke aplikasi Anda, lalu klik Mulai menggunakan Performance Monitoring.
4. Klik Connect to Firebase untuk menghubungkan project Android Anda dengan Firebase (tindakan ini akan membuka Firebase console di browser Anda).
5. Di Firebase console, klik Tambahkan project, lalu masukkan nama project Firebase (jika sudah memiliki project Firebase, Anda dapat memilih project yang sudah ada tersebut). Klik Continue dan setujui persyaratan untuk membuat project Firebase dan Aplikasi Firebase baru.
6. Selanjutnya Anda akan melihat dialog untuk Menghubungkan Aplikasi Firebase baru ke project Android Studio Anda.

7. Kembali ke Android Studio, di panel Assistant, Anda akan melihat konfirmasi bahwa aplikasi telah terhubung ke Firebase.

Menambahkan Performance Monitoring ke aplikasi

Di panel Assistant di Android Studio, klik Add Performance Monitoring to your app.

Anda akan melihat dialog Accept Changes setelah Android Studio harus menyinkronkan aplikasi untuk memastikan bahwa semua dependensi yang diperlukan telah ditambahkan.

Terakhir, Anda akan melihat pesan berhasil di panel Assistant di Android Studio bahwa semua dependensi disiapkan dengan benar.

Sebagai langkah tambahan, aktifkan logging debug dengan mengikuti petunjuk pada langkah "(Opsional) Aktifkan logging debug". Petunjuk yang sama juga tersedia di dokumentasi publik.

Cara lain untuk berintegrasi dengan Firebase Performance Monitoring secara manual dapat ditemukan di sini.

3. Menjalankan aplikasi

Jika Anda telah berhasil mengintegrasikan aplikasi dengan Performance Monitoring SDK, sekarang project seharusnya sudah dikompilasi. Di Android Studio, klik Run > Run 'app' untuk membuat dan menjalankan aplikasi di perangkat/emulator Android yang terhubung.

Aplikasi ini memiliki dua tombol yang membawa Anda ke Aktivitas dan Fragmen yang sesuai, seperti ini:

Pada langkah-langkah codelab ini berikut, Anda akan mempelajari cara mengukur waktu pemuatan dan performa rendering layar Aktivitas atau Fragmen.

4. Memahami pemuatan Aktivitas atau Fragmen

Pada langkah ini, kita akan mempelajari apa yang dilakukan sistem selama pemuatan Aktivitas atau Fragmen.

Memahami pemuatan Aktivitas

Untuk Aktivitas, waktu pemuatan didefinisikan sebagai waktu mulai dari saat objek Aktivitas dibuat hingga Frame Pertama digambar sepenuhnya di layar (saat ini pengguna akan melihat UI lengkap Aktivitas untuk pertama kalinya). Untuk mengukur apakah aplikasi sudah digambar sepenuhnya, Anda dapat menggunakan metode reportFullyDrawn() untuk mengukur waktu yang telah berlalu antara peluncuran aplikasi serta tampilan lengkap semua resource dan hierarki tampilan.

Pada level yang tinggi, saat aplikasi Anda memanggil startActivity(Intent), sistem akan otomatis melakukan proses berikut. Setiap proses memerlukan waktu untuk diselesaikan, yang menambah durasi waktu antara pembuatan Aktivitas dan saat pengguna melihat UI untuk Aktivitas di layar mereka.

Memahami pemuatan Fragmen

Serupa dengan Aktivitas, waktu pemuatan untuk Fragment didefinisikan sebagai waktu mulai dari saat Fragment terpasang ke Aktivitas host-nya hingga First Frame untuk Tampilan Fragmen sepenuhnya digambar di layar.

Catatan: Hampir semua hal di atas untuk Aktivitas dan Fragmen terjadi di thread Utama/UI dan jika Anda melakukan terlalu banyak pekerjaan selama inisialisasi dan/atau hierarki Tampilan terlalu kompleks, Anda dapat membuat pengguna terdampar di layar kosong untuk sementara waktu yang dapat menyebabkan pengalaman pengguna yang buruk.

Berikut ini beberapa referensi untuk membantu memahami dan memperbaiki masalah umum performa pemuatan:

• Performa Rendering Aplikasi
• Performa Rendering
• Waktu Peluncuran Aplikasi
• Waktu Peluncuran Aplikasi & Pembuatan aktivitas
• Pembatalan, Tata Letak, dan Performa

5. Mengukur waktu pemuatan Aktivitas

Penundaan di frame pertama dapat menyebabkan pengalaman pengguna yang buruk. Jadi, penting untuk memahami berapa banyak penundaan pemuatan awal yang dialami pengguna Anda. Anda dapat menggunakan trace kode kustom untuk mengukur waktu pemuatan ini:

1. Mulai trace kode kustom (dinamai TestActivity-LoadTime) di class Activity segera setelah objek Activity dibuat.

TestActivity.java

public class TestActivity extends AppCompatActivity {   
    // TODO (1): Start trace recording as soon as the Activity object is created.
    private final Trace viewLoadTrace = FirebasePerformance.startTrace("TestActivity-LoadTime");

    // ...

}

2. Ganti callback onCreate(), dan dapatkan View yang ditambahkan oleh metode setContentView().

@Override     
public void onCreate(Bundle savedInstanceState) {    
    super.onCreate(savedInstanceState);          

    // Current Activity's main View (as defined in the layout xml file) is inflated after this            
    setContentView(R.layout.activity_test);          

    // ...

    // TODO (2): Get the View added by Activity's setContentView() method.         
    View mainView = findViewById(android.R.id.content);     

    // ...
}

3. Kami telah menyertakan implementasi FistDrawListener, yang memiliki dua callback: onDrawingStart() dan onDrawingFinish() (lihat bagian berikutnya untuk mengetahui detail selengkapnya tentang FirstDrawListener dan hal yang dapat memengaruhi performanya). Daftarkan FirstDrawListener di akhir callback onCreate()Aktivitas. Anda harus menghentikan viewLoadTrace di callback onDrawingFinish().

TestActivity.java

    // TODO (3): Register the callback to listen for first frame rendering (see
    //  "OnFirstDrawCallback" in FirstDrawListener) and stop the trace when View drawing is
    //  finished.
    FirstDrawListener.registerFirstDrawListener(mainView, new FirstDrawListener.OnFirstDrawCallback() {              
        @Override             
        public void onDrawingStart() {       
          // In practice you can also record this event separately
        }

        @Override             
        public void onDrawingFinish() {
            // This is when the Activity UI is completely drawn on the screen
            viewLoadTrace.stop();             
        }         
    });

4. Jalankan kembali aplikasi. Kemudian, filter logcat dengan "Logging trace metric". Ketuk tombol LOAD ACTIVITY, dan cari log seperti di bawah ini:

I/FirebasePerformance: Logging trace metric: TestActivity-LoadTime (duration: XXXms)

🎉 Selamat! Anda berhasil mengukur waktu pemuatan Aktivitas dan melaporkan data tersebut ke Firebase Performance Monitoring. Kita akan melihat metrik yang dicatat di Firebase console nanti dalam codelab ini.

Tujuan FirstDrawListener

Pada bagian di atas, kita telah mendaftarkan FirstDrawListener. Tujuan FirstDrawListener adalah mengukur kapan frame pertama mulai dan selesai menggambar.

Metode ini mengimplementasikan ViewTreeObserver.OnDrawListener dan mengganti callback onDraw() yang dipanggil saat hierarki Tampilan akan digambar. Tindakan ini kemudian menggabungkan hasilnya untuk memberikan dua callback utilitas onDrawingStart() dan onDrawingFinish().

Kode lengkap untuk FirstDrawListener dapat ditemukan dalam kode sumber codelab ini.

Kredit: Kami menggunakan dua postingan blog berikut (yang ditulis oleh Pierre-Yves Ricau) untuk menulis bagian codelab ini:

• Android Vitals - Waktu menggambar pertama kali ]{}{} 🎨
• Android Vitals - Meningkat ke platform pertama yang digambar 🤽 Score️

6. Mengukur waktu pemuatan Fragmen

Mengukur waktu pemuatan Fragmen mirip dengan cara kami mengukurnya untuk Aktivitas, tetapi dengan beberapa perbedaan kecil. Sekali lagi, kita akan menginstrumentasikan trace kode kustom:

1. Ganti callback onAttach() dan mulai rekam fragmentLoadTrace Anda. Kita akan menamai trace ini Test-Fragment-LoadTime.

Seperti yang dijelaskan di langkah sebelumnya, objek Fragment dapat dibuat kapan saja, tetapi objek ini hanya akan aktif jika dikaitkan ke Aktivitas host-nya.

TestFragment.java

public class TestFragment extends Fragment {

   // TODO (1): Declare the Trace variable.
   private Trace fragmentLoadTrace;

   @Override
   public void onAttach(@NonNull Context context) {
       super.onAttach(context);

       // TODO (2): Start trace recording as soon as the Fragment is attached to its host Activity.
       fragmentLoadTrace = FirebasePerformance.startTrace("TestFragment-LoadTime");
   }

2. Daftarkan FirstDrawListener di callback onViewCreated(). Kemudian, mirip dengan contoh Aktivitas, hentikan rekaman aktivitas di onDrawingFinish().

TestFragment.java

@Override
public void onViewCreated(@NonNull View mainView, Bundle savedInstanceState) {
   super.onViewCreated(mainView, savedInstanceState);

   // ...

   // TODO (3): Register the callback to listen for first frame rendering (see
   //  "OnFirstDrawCallback" in FirstDrawListener) and stop the trace when view drawing is
   //  finished.
   FirstDrawListener.registerFirstDrawListener(mainView, new FirstDrawListener.OnFirstDrawCallback() {

       @Override
       public void onDrawingStart() {
           // In practice you can also record this event separately
       }

       @Override
       public void onDrawingFinish() {
           // This is when the Fragment UI is completely drawn on the screen
           fragmentLoadTrace.stop();
       }
   });

3. Jalankan kembali aplikasi. Kemudian, filter logcat dengan "Logging trace metric". Ketuk tombol LOAD FRAGMENT, dan cari log seperti di bawah ini:

I/FirebasePerformance: Logging trace metric: TestFragment-LoadTime (duration: XXXms)

🎉 Selamat! Anda telah berhasil mengukur waktu pemuatan Fragment dan melaporkan data tersebut ke Firebase Performance Monitoring. Kita akan melihat metrik yang dicatat di Firebase console nanti dalam codelab ini.

Catatan: Untuk contoh Aktivitas, Tampilan yang diteruskan ke FirstDrawListener adalah tampilan yang dirujuk dalam metode setContentView(). Namun, untuk contoh Fragment, View tersebut adalah tampilan yang direferensikan dalam callback onViewCreated().

Namun, secara umum, karena pemroses gambar yang terpasang bersifat global untuk seluruh hierarki Tampilan, setiap Tampilan yang dilampirkan akan berfungsi.

7. Memahami Rendering Layar dan apa yang dimaksud dengan frame Lambat/Beku

Rendering UI adalah tindakan menghasilkan frame dari aplikasi dan menampilkannya di layar. Untuk memastikan bahwa interaksi pengguna dengan aplikasi lancar, aplikasi harus merender frame dalam waktu di bawah 16 md untuk mencapai 60 frame per detik ( mengapa 60 fps?). Jika aplikasi mengalami rendering UI yang lambat, sistem akan dipaksa untuk melewati frame, dan pengguna akan melihat ketersendatan di aplikasi. Kami menyebutnya jank.

Demikian pula, periode frozen adalah frame UI yang memerlukan waktu lebih dari 700 md untuk dirender. Penundaan ini menjadi masalah karena aplikasi tampak macet dan tidak responsif terhadap input pengguna selama hampir satu detik saat frame sedang dirender.

Tips: Lihat Performa Rendering dan Memperbaiki Jank untuk memahami dan memperbaiki beberapa masalah umum performa rendering.

Selain itu, perangkat yang lebih modern biasanya memiliki kecepatan refresh >60 Hz, jadi kita tidak boleh selalu mengasumsikan 16 md untuk merender frame. Lihat rendering kecepatan refresh tinggi di Android untuk detail selengkapnya.

8. Mengukur periode Lambat/Beku pada Fragment

Firebase Performance Monitoring otomatis menangkap periode lambat/frozen untuk suatu Aktivitas (tetapi hanya jika Hardware Accelerated). Namun, fitur ini saat ini tidak tersedia untuk Fragment. Periode lambat/frozen Fragment didefinisikan sebagai periode lambat/frozen untuk seluruh Aktivitas antara callback onFragmentAttached() dan onFragmentDetached() dalam siklus proses Fragment.

Dengan mengambil motivasi dari class AppStateMonitor (yang merupakan bagian dari Performance Monitoring SDK yang bertanggung jawab untuk merekam pelacakan layar untuk Activity), kami menerapkan class ScreenTrace (yang merupakan bagian dari repositori kode sumber codelab ini). Class ScreenTrace dapat dikaitkan ke callback siklus proses FragmentManager Aktivitas untuk merekam periode lambat/frozen. Class ini menyediakan dua API publik:

• recordScreenTrace(): Mulai merekam pelacakan layar
• sendScreenTrace(): Menghentikan perekaman pelacakan layar dan melampirkan metrik kustom untuk mencatat jumlah frame Total, Lambat, dan Beku

Dengan melampirkan metrik kustom ini, trace layar untuk Fragment dapat ditangani dengan cara yang sama seperti trace layar untuk Aktivitas dan dapat ditampilkan bersama trace rendering layar lainnya di dasbor Performance di Firebase console.

Berikut cara mencatat rekaman aktivitas layar untuk Fragment Anda:

1. Lakukan inisialisasi class ScreenTrace di Aktivitas Anda yang menghosting Fragment.

MainActivity.java

// Declare the Fragment tag
private static final String FRAGMENT_TAG = TestFragment.class.getSimpleName();

// TODO (1): Declare the ScreenTrace variable.
private ScreenTrace screenTrace;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // TODO (2): Initialize the ScreenTrace variable.
    screenTrace = new ScreenTrace(this, FRAGMENT_TAG);

    // ...
}

2. Saat Anda memuat Fragment, daftar ke FragmentLifecycleCallbacks dan ganti callback onFragmentAttached() dan onFragmentDetached(). Kami telah melakukannya untuk Anda. Anda harus mulai merekam pelacakan layar di callback onFragmentAttached() dan berhenti merekam di callback onFragmentDetached().

MainActivity.java

private final FragmentManager.FragmentLifecycleCallbacks fragmentLifecycleCallbacks =
       new FragmentManager.FragmentLifecycleCallbacks() {

           @Override
           public void onFragmentAttached(@NonNull FragmentManager fm, @NonNull Fragment f, @NonNull Context context) {
               super.onFragmentAttached(fm, f, context);

               // TODO (3): Start recording the screen traces as soon as the Fragment is
               //  attached to its host Activity.
               if (FRAGMENT_TAG.equals(f.getTag()) && screenTrace.isScreenTraceSupported()) {
                   screenTrace.recordScreenTrace();
               }
           }

           @Override
           public void onFragmentDetached(@NonNull FragmentManager fm, @NonNull Fragment f) {
               super.onFragmentDetached(fm, f);

               // TODO (4): Stop recording the screen traces as soon as the Fragment is
               //  detached from its host Activity.
               if (FRAGMENT_TAG.equals(f.getTag()) && screenTrace.isScreenTraceSupported()) {
                   screenTrace.sendScreenTrace();
               }

               // Unregister Fragment lifecycle callbacks after the Fragment is detached
               fm.unregisterFragmentLifecycleCallbacks(fragmentLifecycleCallbacks);
           }
       };

4. Jalankan kembali aplikasi. Lalu, ketuk tombol LOAD FRAGMENT. Tunggu beberapa detik, lalu klik back button di menu navigasi bawah.

Filter logcat dengan "Logging trace metric", lalu cari log seperti di bawah:

I/FirebasePerformance: Logging trace metric: _st_MainActivity-TestFragment (duration: XXXms)

Filter logcat dengan "FireperfViews", lalu cari log seperti di bawah:

D/FireperfViews: sendScreenTrace MainActivity-TestFragment, name: _st_MainActivity-TestFragment, total_frames: XX, slow_frames: XX, frozen_frames: XX

🎉 Selamat! Anda berhasil mengukur periode Lambat/Beku untuk sebuah Fragment dan melaporkan data tersebut ke Firebase Performance Monitoring. Kita akan melihat metrik yang direkam di Firebase console nanti dalam codelab ini.

9. Memeriksa metrik di Firebase console

1. Di logcat, klik URL Firebase console untuk membuka halaman detail untuk pelacakan.

Atau, di Firebase console, pilih project yang memiliki aplikasi Anda. Di panel kiri, cari bagian Release & Monitor, lalu klik Performance.

• Di tab Dashboard utama, scroll ke bawah ke tabel trace, lalu klik tab Custom traces. Dalam tabel ini, Anda akan melihat trace kode kustom yang kita tambahkan sebelumnya serta beberapa trace siap pakai, seperti trace _app_start.
• Temukan dua trace kode kustom Anda, TestActivity-LoadTime dan TestFragment-LoadTime. Klik Durasi untuk salah satu opsi guna melihat detail lebih lanjut tentang data yang dikumpulkan.

Catatan: Jika Anda tidak melihat data, luncurkan kembali aplikasi dan biarkan berjalan minimal selama 30 detik.

2. Halaman detail untuk trace kode kustom menunjukkan informasi tentang durasi trace (yaitu waktu pemuatan yang diukur).

3. Anda juga dapat melihat data performa untuk trace layar kustom.

• Kembali ke tab Dasbor utama, scroll ke bawah ke tabel trace, lalu klik tab Rendering layar. Dalam tabel ini, Anda akan melihat trace layar kustom yang kita tambahkan sebelumnya serta trace layar siap pakai, seperti trace MainActivity.
• Temukan trace layar kustom Anda, MainActivity-TestFragment. Klik nama rekaman aktivitas untuk melihat data gabungan dari rendering lambat dan periode frozen.

10. Selamat

Selamat! Anda telah berhasil mengukur waktu pemuatan dan performa rendering layar dari Aktivitas dan Fragmen dengan menggunakan Firebase Performance Monitoring.

Yang telah Anda capai

• Anda mengintegrasikan Firebase Performance Monitoring ke dalam aplikasi contoh
• Anda sekarang memahami siklus proses pemuatan Tampilan
• Anda mengukur waktu pemuatan Aktivitas dan Fragmen dengan menambahkan trace kode kustom
• Anda merekam periode lambat/frozen dengan menambahkan pelacakan layar kustom dengan metrik kustom

Langkah selanjutnya

Firebase Performance menyediakan lebih banyak cara untuk mengukur performa aplikasi Anda selain pelacakan kustom. Fitur ini otomatis mengukur data waktu startup aplikasi, aplikasi di latar depan, dan aplikasi di latar belakang. Sekarang saatnya Anda memeriksa metrik ini di Firebase Console.

Selain itu, Firebase Performance menawarkan pemantauan permintaan jaringan HTTP/S otomatis. Dengan demikian, Anda dapat dengan mudah menginstrumentasikan permintaan jaringan tanpa menulis satu baris kode pun. Dapatkah Anda mencoba mengirim beberapa permintaan jaringan dari aplikasi dan menemukan metrik di Firebase console?

Bonus

Setelah mengetahui cara mengukur waktu pemuatan dan performa rendering layar Aktivitas/Fragmen menggunakan trace kode kustom, dapatkah Anda mempelajari code base open source kami untuk melihat apakah Anda dapat langsung menangkap metrik tersebut untuk Aktivitas/Fragmen apa pun yang merupakan bagian dari aplikasi? Jangan ragu untuk mengirimkan PR jika Anda mau :-)

11. Pembelajaran Bonus

Memahami apa yang terjadi selama pemuatan Aktivitas akan membantu Anda lebih memahami karakteristik performa aplikasi. Pada langkah sebelumnya, kami menjelaskan secara umum apa yang terjadi selama pemuatan Aktivitas, tetapi diagram berikut menjelaskan setiap fase dengan lebih mendetail.