為特定應用代碼添加自定義監控

性能監控收集跟踪來幫助您監控應用程序的性能。跟踪是應用程序中兩個時間點之間捕獲的性能數據的報告。

您可以創建自己的跟踪來監控與應用程序中特定代碼關聯的性能數據。通過自定義代碼跟踪，您可以測量應用程序完成一項特定任務或一組任務（例如加載一組圖像或查詢數據庫）所需的時間。

自定義代碼跟踪的默認指標是其“持續時間”（跟踪的起始點和停止點之間的時間），但您也可以添加自定義指標。

在代碼中，您可以使用性能監控 SDK 提供的 API 定義自定義代碼跟踪的開始和結束。對於 Android 應用程序，您還可以使用@AddTrace註解監視特定方法。自定義代碼跟踪可以在創建後隨時啟動，並且它們是線程安全的。

由於為這些跟踪收集的默認指標是“持續時間”，因此它們有時稱為“持續時間跟踪”。

您可以在跟踪表的自定義跟踪子選項卡中查看這些跟踪中的數據，該表位於性能儀表板的底部（稍後將詳細了解如何使用控制台）。

默認屬性、自定義屬性和自定義指標

您可以進一步配置自定義代碼跟踪，以記錄跟踪範圍內發生的與性能相關的事件的自定義指標。例如，您可以為緩存命中和未命中次數或 UI 在一段時間內變得無響應的次數創建自定義指標。

自定義屬性和自定義指標與跟踪的默認屬性和默認指標一起顯示在 Firebase 控制台中。

添加自定義代碼跟踪

使用性能監控跟踪 API添加自定義代碼跟踪以監控特定應用程序代碼。

請注意以下事項：

• 一個應用程序可以有多個自定義代碼跟踪。
• 可以同時運行多個自定義代碼跟踪。
• 自定義代碼跟踪的名稱必須滿足以下要求：沒有前導或尾隨空格、沒有前導下劃線 ( _ ) 字符、最大長度為 100 個字符。
• 自定義代碼跟踪支持添加自定義指標和自定義屬性。

要啟動和停止自定義代碼跟踪，請使用類似於以下的代碼行包裝要跟踪的代碼（本示例使用自定義跟踪名稱test_trace ）：

// 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()
MainActivity.kt

// 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();
MainActivity.java

（可選）使用@AddTrace監視特定方法

Android 應用程序還支持@AddTrace註釋來檢測自定義代碼跟踪。使用此功能，跟踪從指定方法的開頭開始，並在該方法完成時停止，包括該方法調用的任何內容。

例如，您可以創建一個名為onCreateTrace的自定義代碼跟踪，該跟踪在調用onCreate()方法時運行。

// 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
// the `enabled` argument is optional and defaults to true
@AddTrace(name = "onCreateTrace", enabled = true)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}
MainActivity.kt

// 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);
}
MainActivity.java

將自定義指標添加到自定義代碼跟踪

使用性能監控跟踪 API將自定義指標添加到自定義代碼跟踪中。

請注意以下事項：

• 自定義指標的名稱必須滿足以下要求：沒有前導或尾隨空格、沒有前導下劃線 ( _ ) 字符、最大長度為 100 個字符。
• 每個自定義代碼跟踪最多可以記錄 32 個指標（包括默認的持續時間指標）。

要添加自定義指標，請在每次事件發生時添加一行類似於以下內容的代碼。例如，此自定義指標對應用程序中發生的與性能相關的事件進行計數，例如緩存命中和未命中（使用示例事件名稱item_cache_hit和item_cache_miss以及增量1 ）。

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()
MainActivity.kt

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();
MainActivity.java

為自定義代碼跟踪創建自定義屬性

要使用自定義屬性，請將代碼添加到定義該屬性並將其與特定自定義代碼跟踪關聯的應用程序。您可以在跟踪開始和跟踪停止之間隨時設置自定義屬性。

請注意以下事項：

• 自定義屬性的名稱必須滿足以下要求：

  • 沒有前導或尾隨空格，沒有前導下劃線 ( _ ) 字符
  • 沒有空間
  • 最大長度為 32 個字符
  • 名稱允許的字符包括AZ 、 az和_ 。

• 每個自定義代碼跟踪最多可以記錄 5 個自定義屬性。

• 請確保自定義屬性不包含任何可向 Google 識別個人身份的信息。

  了解有關本指南的更多信息

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
}
MainActivity.kt

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();
MainActivity.java

跟踪、查看和過濾性能數據

跟踪儀表板中的特定指標

要了解關鍵指標的趨勢，請將它們添加到績效儀表板頂部的指標板中。您可以通過查看每週的變化來快速識別回歸，或者驗證代碼中的最新更改是否正在提高性能。

要將指標添加到指標板，請執行以下步驟：

1. 轉到 Firebase 控制台中的性能儀表板。
2. 單擊空指標卡，然後選擇現有指標以添加到您的看板中。
3. 單擊填充的指標卡上的more_vert可獲取更多選項，例如替換或刪除指標。

指標板以圖形形式和數字百分比變化的形式顯示隨時間推移收集的指標數據。

了解有關使用儀表板的更多信息。

查看踪跡及其數據

要查看跟踪，請轉到 Firebase 控制台中的性能儀表板，向下滾動到跟踪表，然後單擊相應的子選項卡。該表顯示每個跟踪的一些主要指標，您甚至可以按特定指標的百分比變化對列表進行排序。

性能監控在 Firebase 控制台中提供了一個故障排除頁面，其中突出顯示了指標更改，從而可以輕鬆快速解決性能問題並最大程度地減少其對應用和用戶的影響。當您了解潛在的性能問題時，您可以使用故障排除頁面，例如，在以下場景中：

• 您在儀表板上選擇相關指標，您會注意到一個很大的增量。
• 在跟踪表中，您進行排序以在頂部顯示最大增量，並且您會看到顯著的百分比變化。
• 您會收到一封電子郵件警報，通知您出現性能問題。

您可以通過以下方式進入故障排除頁面：

• 在指標儀表板上，單擊查看指標詳細信息按鈕。
• 在任何指標卡上，選擇more_vert => 查看詳細信息。故障排除頁面顯示有關您選擇的指標的信息。
• 在跟踪表中，單擊跟踪名稱或與該跟踪關聯的行中的任何指標值。
• 在電子郵件警報中，單擊“立即調查” 。

當您單擊跟踪表中的跟踪名稱時，您可以深入了解感興趣的指標。單擊“過濾器add按鈕可按屬性過濾數據，例如：

• 按應用程序版本過濾以查看有關過去版本或最新版本的數據
• 按設備過濾以了解舊設備如何處理您的應用
• 按國家/地區過濾以確保您的數據庫位置不會影響特定區域

了解有關查看跟踪數據的更多信息。

下一步

• 了解有關使用屬性檢查性能數據的更多信息。

• 詳細了解如何在 Firebase 控制台中跟踪性能問題。

• 針對會降低應用程序性能的代碼更改設置警報。例如，如果特定自定義代碼跟踪的持續時間超過您設置的閾值，您可以為您的團隊配置電子郵件警報。

• 查看用戶會話的詳細報告，您可以在其中看到同一會話期間收集的其他跟踪的時間線上下文中的特定跟踪。