Tambahkan pemantauan khusus untuk kode aplikasi tertentu

Performance Monitoring mengumpulkan jejak untuk membantu Anda memantau kinerja aplikasi Anda. Jejak adalah laporan data kinerja yang diambil antara dua titik waktu di aplikasi Anda.

Anda dapat membuat pelacakan sendiri untuk memantau data kinerja yang terkait dengan kode tertentu di aplikasi Anda. Dengan pelacakan kode khusus , Anda dapat mengukur berapa lama waktu yang dibutuhkan aplikasi untuk menyelesaikan tugas tertentu atau serangkaian tugas, misalnya memuat sekumpulan gambar atau mengkueri database Anda.

Metrik default untuk pelacakan kode khusus adalah "durasi" (waktu antara titik awal dan titik berhenti pelacakan), tetapi Anda juga dapat menambahkan metrik khusus .

Dalam kode Anda, Anda menentukan awal dan akhir pelacakan kode khusus menggunakan API yang disediakan oleh Performance Monitoring SDK.Untuk aplikasi Android, Anda juga dapat memantau metode tertentu menggunakan anotasi @AddTrace .kode kustom dapat dimulai kapan saja setelah dibuat, dan aman untuk thread.

Karena metrik default yang dikumpulkan untuk pelacakan ini adalah "durasi", metrik tersebut terkadang disebut "Jejak durasi".

Anda dapat melihat data dari pelacakan ini di subtab Jejak kustom pada tabel pelacakan, yang ada di bagian bawah dasbor Performa (pelajari lebih lanjut tentang menggunakan konsol nanti di halaman ini).

Atribut default, atribut khusus, dan metrik khusus

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

Anda dapat mengonfigurasi lebih lanjut pelacakan kode khusus untuk merekam metrik khusus untuk peristiwa terkait kinerja yang terjadi dalam cakupan pelacakan. Misalnya, Anda dapat membuat metrik khusus untuk jumlah klik dan kesalahan cache atau berapa kali UI menjadi tidak responsif selama jangka waktu tertentu.

Atribut khusus dan metrik khusus ditampilkan di Firebase console bersama atribut default dan metrik default untuk pelacakan.

Tambahkan jejak kode khusus

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

Perhatikan hal berikut:

  • Sebuah aplikasi dapat memiliki beberapa pelacakan kode kustom.
  • Lebih dari satu pelacakan kode khusus dapat berjalan secara bersamaan.
  • Nama untuk pelacakan kode khusus harus memenuhi persyaratan berikut: tidak boleh ada spasi di depan atau di belakang, tidak ada karakter garis bawah di depan ( _ ), dan panjang maksimal 100 karakter.
  • Jejak kode khusus mendukung penambahan metrik khusus dan atribut khusus .

Untuk memulai dan menghentikan pelacakan kode kustom, bungkus kode yang ingin Anda lacak dengan baris kode yang mirip dengan berikut ini (contoh ini menggunakan nama pelacakan kustom test_trace ):

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace

myTrace.stop();

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace

myTrace.stop()

(Opsional) Pantau metode tertentu menggunakan @AddTrace

Aplikasi Android juga mendukung anotasi @AddTrace untuk menginstrumentasikan pelacakan kode khusus. Dengan menggunakan fitur ini, pelacakan dimulai pada awal metode yang ditentukan dan berhenti saat metode selesai, termasuk apa pun yang dipanggil oleh metode tersebut.

Misalnya, Anda dapat membuat pelacakan kode kustom yang disebut onCreateTrace yang berjalan saat metode onCreate() dipanggil.

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}

Tambahkan metrik khusus ke jejak kode khusus

Gunakan Performance Monitoring Trace API untuk menambahkan metrik khusus ke pelacakan kode khusus.

Perhatikan hal berikut:

  • Nama untuk metrik khusus harus memenuhi persyaratan berikut: tidak boleh ada spasi di depan atau di belakang, tidak ada karakter garis bawah di depan ( _ ), dan panjang maksimal 100 karakter.
  • Setiap pelacakan kode khusus dapat merekam hingga 32 metrik (termasuk metrik Durasi default).

Untuk menambahkan metrik khusus, tambahkan baris kode yang mirip dengan berikut ini setiap kali peristiwa terjadi. Misalnya, metrik khusus ini menghitung peristiwa terkait kinerja yang terjadi di aplikasi Anda, seperti klik dan kesalahan cache (menggunakan contoh nama peristiwa item_cache_hit dan item_cache_miss dan peningkatan 1 ).

Java

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace (and log custom metrics)
Item item = cache.fetch("item");
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1);
} else {
    myTrace.incrementMetric("item_cache_miss", 1);
}

myTrace.stop();

Kotlin+KTX

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace (and log custom metrics)
val item = cache.fetch("item")
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1)
} else {
    myTrace.incrementMetric("item_cache_miss", 1)
}

myTrace.stop()

Buat atribut khusus untuk jejak kode khusus

Gunakan Performance Monitoring Trace API untuk menambahkan atribut khusus ke pelacakan kode khusus.

Untuk menggunakan atribut khusus, tambahkan kode ke aplikasi Anda yang mendefinisikan atribut dan kaitkan dengan pelacakan kode khusus tertentu. Anda dapat menyetel atribut khusus kapan saja antara saat pelacakan dimulai dan saat pelacakan berhenti.

Perhatikan hal berikut:

  • Nama untuk atribut khusus harus memenuhi persyaratan berikut: tidak boleh ada spasi di depan atau di belakang, tidak ada karakter garis bawah di depan ( _ ), dan panjang maksimal 32 karakter.

  • Setiap pelacakan kode khusus dapat merekam hingga 5 atribut khusus.

  • Anda tidak boleh menggunakan atribut khusus yang berisi informasi yang secara pribadi mengidentifikasi individu ke Google.

    Pelajari lebih lanjut tentang pedoman ini

Java

Trace trace = FirebasePerformance.getInstance().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();

Kotlin+KTX

Firebase.performance.newTrace("test_trace").trace {
    // Update scenario.
    putAttribute("experiment", "A")

    // Reading scenario.
    val experimentValue = getAttribute("experiment")

    // Delete scenario.
    removeAttribute("experiment")

    // Read attributes.
    val traceAttributes = this.attributes
}

Lacak, lihat, dan filter data kinerja

Lacak metrik tertentu di dasbor Anda

Untuk mempelajari tren metrik utama Anda, tambahkan metrik tersebut ke papan metrik Anda di bagian atas dasbor Performa . Anda dapat dengan cepat mengidentifikasi regresi dengan melihat perubahan dari minggu ke minggu atau memverifikasi bahwa perubahan terbaru dalam kode Anda meningkatkan kinerja.

gambar papan metrik di dasbor Firebase Performance Monitoring

Untuk menambahkan metrik ke papan metrik Anda, ikuti langkah-langkah berikut:

  1. Buka dasbor Performa di konsol Firebase.
  2. Klik kartu metrik kosong, lalu pilih metrik yang ada untuk ditambahkan ke papan Anda.
  3. Klik pada kartu metrik yang terisi untuk opsi lainnya, misalnya untuk mengganti atau menghapus metrik.

Papan metrik menunjukkan data metrik yang dikumpulkan dari waktu ke waktu, baik dalam bentuk grafik maupun sebagai persentase perubahan numerik.

Pelajari lebih lanjut tentang menggunakan dasbor .

Lihat jejak dan datanya

Untuk melihat pelacakan Anda, buka dasbor Performa di Firebase console, gulir ke bawah ke tabel pelacakan, lalu klik subtab yang sesuai. Tabel menampilkan beberapa metrik teratas untuk setiap jejak, dan Anda bahkan dapat mengurutkan daftar menurut persentase perubahan untuk metrik tertentu.

Performance Monitoring menyediakan halaman pemecahan masalah di Firebase console yang menyoroti perubahan metrik, sehingga memudahkan untuk mengatasi dan meminimalkan dampak masalah performa pada aplikasi dan pengguna Anda dengan cepat. Anda dapat menggunakan halaman pemecahan masalah saat mempelajari tentang potensi masalah kinerja, misalnya, dalam skenario berikut:

  • Anda memilih metrik yang relevan di dasbor dan Anda melihat delta besar.
  • Di tabel pelacakan, Anda mengurutkan untuk menampilkan delta terbesar di bagian atas, dan Anda melihat perubahan persentase yang signifikan.
  • Anda menerima peringatan email yang memberi tahu Anda tentang masalah kinerja.

Anda dapat mengakses halaman pemecahan masalah dengan cara berikut:

  • Di dasbor metrik, klik tombol Lihat detail metrik .
  • Pada kartu metrik mana pun, pilih => Lihat detail . Halaman pemecahan masalah menampilkan informasi tentang metrik yang Anda pilih.
  • Di tabel pelacakan, klik nama pelacakan atau nilai metrik apa pun di baris yang terkait dengan pelacakan tersebut.
  • Dalam lansiran email, klik Selidiki sekarang .

Saat Anda mengklik nama pelacakan di tabel pelacakan, Anda kemudian dapat menelusuri metrik yang diminati. Klik tombol Filter untuk memfilter data berdasarkan atribut, misalnya:

gambar data Firebase Performance Monitoring yang difilter menurut atribut
  • Filter menurut versi Aplikasi untuk melihat data tentang rilis sebelumnya atau rilis terbaru Anda
  • Filter menurut Perangkat untuk mempelajari cara perangkat lama menangani aplikasi Anda
  • Filter menurut Negara untuk memastikan lokasi basis data Anda tidak memengaruhi wilayah tertentu

Pelajari lebih lanjut tentang melihat data untuk jejak Anda .

Langkah selanjutnya

  • Pelajari lebih lanjut tentang menggunakan atribut untuk memeriksa data kinerja.

  • Pelajari lebih lanjut cara melacak masalah performa di Firebase console.

  • Siapkan peringatan untuk perubahan kode yang menurunkan kinerja aplikasi Anda. Misalnya, Anda dapat mengonfigurasi peringatan email untuk tim Anda jika durasi pelacakan kode kustom tertentu melebihi ambang batas yang Anda tetapkan.

  • Lihat laporan rinci sesi pengguna di mana Anda dapat melihat jejak tertentu dalam konteks garis waktu dari jejak lain yang dikumpulkan selama sesi yang sama.