為特定應用程式程式碼新增自訂監控功能


效能監控會收集追蹤記錄，協助您監控應用程式的效能。追蹤記錄是應用程式在兩個時間點之間擷取的效能資料報表。

您可以自行建立追蹤記錄，監控應用程式中與特定程式碼相關聯的成效資料。透過自訂程式碼追蹤記錄，您可以評估應用程式完成特定工作或一組工作所需的時間，例如載入一組圖片或查詢資料庫。

自訂程式碼追蹤記錄的預設指標為「持續時間」(追蹤記錄的開始點和結束點之間的時間)，但您也可以新增自訂指標。

在程式碼中，您可以使用 Performance Monitoring SDK 提供的 API 定義自訂程式碼追蹤的起點和終點。

自訂程式碼追蹤記錄可在建立後隨時啟動，且具有執行緒安全性。

由於這些追蹤記錄收集的預設指標為「時間長度」，因此有時會稱為「時間長度追蹤記錄」。

您可以在追蹤記錄表的「自訂追蹤記錄」子頁籤中查看這些追蹤記錄的資料，該子頁籤位於「效能」資訊主頁的底部 (請參閱本頁後續的使用主控台相關說明)。

預設屬性、自訂屬性和自訂指標

對於自訂程式碼追蹤記錄，Performance Monitoring 會自動記錄預設屬性 (應用程式版本、國家/地區、裝置等常見中繼資料)，方便您在 Firebase 控制台中篩選追蹤記錄資料。您也可以新增及監控自訂屬性 (例如遊戲等級或使用者屬性)。

您可以進一步設定自訂程式碼追蹤，為追蹤範圍內發生的效能相關事件記錄自訂指標。舉例來說，您可以建立自訂指標，用於計算快取命中和未命中的次數，或是 UI 在一段明顯的時間內未回應的次數。

自訂屬性和自訂指標會在 Firebase 主控台中顯示，並與追蹤記錄的預設屬性和預設指標並列。

新增自訂程式碼追蹤記錄

使用 Performance Monitoring Trace API 新增自訂程式碼追蹤記錄，以便監控特定應用程式程式碼。

注意事項：

  • 應用程式可以有多個自訂程式碼追蹤記錄。
  • 您可以同時執行多個自訂程式碼追蹤記錄。
  • 自訂程式碼追蹤記錄的名稱必須符合下列規定：開頭或結尾不得有空白字元、開頭不得有底線 (_) 字元，且長度上限為 100 個半形字元。
  • 自訂程式碼追蹤記錄支援新增自訂指標和自訂屬性。

如要啟動及停止自訂程式碼追蹤，請使用類似以下的程式碼包裝要追蹤的程式碼：

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

// Code you want to trace

await customTrace.stop();

在自訂程式碼追蹤記錄中新增自訂指標

使用 Performance Monitoring Trace API 將自訂指標新增至自訂程式碼追蹤記錄。

注意事項：

  • 自訂指標的名稱必須符合下列規定：開頭或結尾不得有空白字元、開頭不得有底線 (_) 字元，且長度不得超過 100 個字元。
  • 每個自訂程式碼追蹤記錄最多可記錄 32 個指標 (包括預設的「Duration」指標)。

如要新增自訂指標，請在每次事件發生時，新增一行類似以下的程式碼。舉例來說，這個自訂指標會計算應用程式中發生的效能相關事件，例如快取命中或重試。

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();

為自訂程式碼追蹤記錄建立自訂屬性

如要使用自訂屬性，請在應用程式中新增程式碼，定義屬性並將其與特定自訂程式碼追蹤連結。您可以在追蹤開始和停止之間的任何時間設定自訂屬性。

注意事項：

  • 自訂屬性名稱必須符合下列規定：開頭或結尾不得有空白字元、開頭不得有底線 (_) 字元，且長度上限為 32 個半形字元。

  • 每個自訂程式碼追蹤最多可記錄 5 個自訂屬性。

  • 請勿使用含有個人識別資訊的自訂屬性，以免將個人資訊提供給 Google。

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();

追蹤、查看及篩選成效資料

在資訊主頁中追蹤特定指標

如要瞭解重要指標的趨勢，請將指標加入「成效」資訊主頁頂端的指標看板。您可以查看每週變化，快速找出迴歸問題，或是驗證程式碼的近期變更是否有助於改善效能。

如要在指標看板中新增指標，請前往 Firebase 控制台的「成效」資訊主頁，然後按一下「資訊主頁」分頁標籤。按一下空白的指標資訊卡，然後選取現有指標，即可新增至看板。按一下已填入指標資訊的資訊卡上垂直的省略號圖示 (⋮)，即可查看更多選項，例如取代或移除指標。

指標資訊主頁會顯示收集到的指標資料，包括圖表形式和數字百分比變化。

進一步瞭解如何使用資訊主頁。

查看追蹤記錄及其資料

如要查看追蹤記錄，請前往 Firebase 主控台的「效能」資訊主頁，捲動至追蹤記錄表格，然後按一下適當的子頁籤。表格會顯示每個追蹤記錄的部分主要指標，您甚至可以依特定指標的百分比變化排序清單。

如果您在追蹤記錄表中按一下追蹤記錄名稱，即可按一下各個畫面來探索追蹤記錄，並深入瞭解感興趣的指標。在大多數頁面中，您可以使用「篩選」按鈕 (畫面左上方)，依屬性篩選資料，例如：

  • 依「應用程式版本」篩選，查看過去或最新版本的資料
  • 依「裝置」篩選，瞭解舊版裝置如何處理您的應用程式
  • 依「國家/地區」篩選，確認資料庫位置不會影響特定區域

進一步瞭解如何查看追蹤記錄資料。

後續步驟

  • 進一步瞭解如何使用屬性檢查成效資料。

  • 進一步瞭解如何在 Firebase 控制台中追蹤效能問題。

  • 設定快訊，以便在程式碼變更導致應用程式效能降低時發出通知。舉例來說，如果特定自訂程式碼追蹤的時間長度超過您設定的門檻，您可以為團隊設定電子郵件快訊。