Menambahkan pemantauan kustom untuk kode aplikasi tertentu

Performance Monitoring mengumpulkan trace untuk membantu Anda memantau performa aplikasi. Trace adalah laporan data performa yang dicatat antara dua titik waktu dalam aplikasi Anda.

Anda dapat membuat trace sendiri untuk memantau data performa yang berkaitan dengan kode tertentu di aplikasi. Dengan trace kode kustom, Anda dapat mengukur waktu yang dibutuhkan aplikasi untuk menyelesaikan satu atau serangkaian tugas, misalnya memuat serangkaian gambar atau membuat kueri database.

Metrik default untuk trace kode kustom adalah "duration" (waktu antara titik awal dan titik pemberhentian trace), tetapi Anda juga dapat menambahkan metrik kustom.

Dalam kode, penentuan awal dan akhir trace kode kustom dilakukan menggunakan API yang diberikan oleh Performance Monitoring SDK.

Trace kode kustom dapat dimulai kapan saja setelah dibuat, dan aman untuk thread.

Karena metrik default yang dikumpulkan untuk trace ini adalah "duration", trace tersebut terkadang disebut sebagai "Trace durasi".

Anda dapat melihat data dari trace ini di subtab Trace kustom pada tabel trace, yang ada di bagian bawah dasbor Performance (pelajari lebih lanjut cara menggunakan konsol nanti di halaman ini).

Atribut default, atribut khusus, dan metrik kustom

Untuk trace kode kustom, Performance Monitoring otomatis mencatat atribut default (metadata umum seperti versi aplikasi, negara, perangkat, dll.) ke dalam log sehingga Anda dapat memfilter data trace tersebut di Firebase console. Anda juga dapat menambahkan dan memantau atribut khusus (seperti level game atau properti pengguna).

Anda dapat mengonfigurasi trace kode kustom lebih lanjut untuk mencatat metrik kustom untuk peristiwa terkait performa yang terjadi dalam cakupan trace. Misalnya, Anda dapat membuat metrik kustom untuk jumlah cache ditemukan dan cache tidak ditemukan, atau berapa kali UI tidak responsif selama periode waktu yang cukup panjang.

Atribut khusus dan metrik kustom ditampilkan di Firebase console bersama dengan atribut default dan metrik default untuk trace.

Menambahkan trace kode kustom

Gunakan Performance Monitoring Trace API untuk menambahkan trace kode kustom guna memantau kode aplikasi tertentu.

Perhatikan hal berikut:

Sebuah aplikasi dapat memiliki beberapa trace kode kustom.
Lebih dari satu trace kode kustom dapat berjalan secara bersamaan.
Nama untuk trace kode kustom harus memenuhi persyaratan berikut: tidak boleh ada spasi kosong di awal atau akhir, tidak boleh diawali dengan karakter garis bawah (_), dan panjang maksimal adalah 100 karakter.
Trace kode kustom mendukung penambahan metrik kustom dan atribut khusus.

Untuk memulai dan menghentikan trace kode kustom, kurung kode yang ingin dilacak dengan kode yang mirip dengan di bawah ini:

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

Menambahkan metrik kustom ke trace kode kustom

Gunakan Performance Monitoring Trace API untuk menambahkan metrik kustom ke trace kode kustom.

Perhatikan hal berikut:

Nama untuk metrik kustom harus memenuhi persyaratan berikut: tidak boleh ada spasi kosong di awal atau akhir, tidak boleh diawali dengan karakter garis bawah (_), dan panjang maksimal adalah 100 karakter.
Setiap trace kode kustom dapat mencatat hingga 32 metrik (termasuk metrik Duration default).

Untuk menambahkan metrik kustom, tambahkan baris kode yang mirip dengan yang berikut ini setiap kali peristiwa tersebut terjadi. Misalnya, metrik kustom ini menghitung peristiwa terkait performa yang terjadi di aplikasi Anda, seperti cache ditemukan atau dicoba ulang.

Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();

// Code you want to trace

customTrace.incrementMetric("metric-name", 1);

// More code

await customTrace.stop();

Membuat atribut khusus untuk trace kode kustom

Untuk menggunakan atribut khusus, tambahkan kode ke aplikasi Anda yang menentukan atribut dan mengaitkannya dengan trace kode kustom tertentu. Anda dapat menetapkan atribut khusus kapan saja antara saat trace dimulai dan saat trace berhenti.

Perhatikan hal berikut:

Nama untuk atribut khusus harus memenuhi persyaratan berikut: tidak boleh ada spasi kosong di awal atau akhir, tidak boleh diawali dengan karakter garis bawah (_), dan panjang maksimal adalah 32 karakter.
Setiap trace kode kustom dapat mencatat hingga 5 atribut khusus.
Anda tidak boleh menggunakan atribut khusus yang berisi informasi yang mengidentifikasi seseorang secara pribadi ke Google.
Mengumpulkan data pengguna

Performance Monitoring sendiri tidak mengumpulkan informasi identitas pribadi (PII), seperti nama, alamat email, atau nomor telepon. Developer dapat mengumpulkan data tambahan menggunakan Performance Monitoring dengan membuat atribut khusus pada trace kode kustom. Data yang dikumpulkan melalui Performance Monitoring tidak boleh berisi informasi yang mengidentifikasi seseorang secara pribadi ke Google.

Berikut ini contoh pesan log yang tidak berisi informasi identitas pribadi:
```
customTrace.putAttribute("experiment", "A");  // OK
```
Berikut ini contoh yang berisi informasi identitas pribadi (jangan gunakan atribut khusus semacam ini di aplikasi Anda):
```
customTrace.putAttribute(("email", user.getEmailAddress());  // Don't do this!
```
Data yang menunjukkan informasi identitas pribadi dapat dihapus tanpa pemberitahuan.

Trace trace = FirebasePerformance.instance.newTrace("test_trace");

// Update scenario.
trace.putAttribute("experiment", "A");

// Reading scenario.
String? experimentValue = trace.getAttribute("experiment");

// Delete scenario.
trace.removeAttribute("experiment");

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();

Melacak, melihat, dan memfilter data performa

Melacak metrik tertentu di dasbor Anda

Untuk mempelajari tren metrik utama, tambahkan metrik tersebut ke bagan metrik di bagian atas dasbor Performance. Anda dapat dengan cepat mengidentifikasi regresi dengan melihat perubahan dari minggu ke minggu atau memverifikasi bahwa perubahan terbaru pada kode Anda meningkatkan performa.

Untuk menambahkan metrik ke bagan metrik, buka dasbor Performance di Firebase console, lalu klik tab Dashboard. Klik kartu metrik kosong, lalu pilih metrik yang ada untuk ditambahkan ke bagan. Klik elipsis vertikal (⋮) di kartu metrik yang terisi untuk melihat opsi lainnya, seperti mengganti atau menghapus metrik.

Bagan metrik menampilkan data metrik yang dikumpulkan dari waktu ke waktu, baik dalam bentuk grafis maupun sebagai perubahan persentase numerik.

Pelajari lebih lanjut cara menggunakan dasbor.

Melihat trace dan datanya

Untuk melihat trace, buka dasbor Performance di Firebase console, scroll ke bawah ke tabel trace, lalu klik subtab yang sesuai. Tabel ini menampilkan beberapa metrik teratas untuk setiap trace, dan Anda bahkan dapat mengurutkan daftar berdasarkan perubahan persentase untuk metrik tertentu.

Jika nama trace di tabel trace diklik, Anda dapat mengklik berbagai layar untuk mempelajari trace dan melihat perincian metrik yang diinginkan. Pada sebagian besar halaman, Anda dapat menggunakan tombol Filter (kiri atas layar) untuk memfilter data menurut atribut, misalnya:

Filter menurut App version untuk melihat data tentang rilis sebelumnya atau rilis terbaru
Filter menurut Device untuk mempelajari cara perangkat lama menangani aplikasi Anda
Filter menurut Country untuk memastikan lokasi database Anda tidak memengaruhi region tertentu

Pelajari lebih lanjut cara melihat data untuk trace Anda.

Langkah Berikutnya

Pelajari lebih lanjut cara menggunakan atribut untuk memeriksa data performa.
Pelajari cara melacak masalah performa lebih lanjut di Firebase console.
Siapkan pemberitahuan untuk perubahan kode yang menurunkan performa aplikasi Anda. Misalnya, Anda dapat mengonfigurasi peringatan email untuk tim jika durasi trace kode kustom tertentu melebihi batas yang Anda tetapkan.