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


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

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

自訂程式碼追蹤記錄的預設指標為「時間長度」(從 追蹤記錄的起點和停止點)，但您可以新增 自訂指標。

在程式碼中，您可以使用 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 個自訂屬性。

  • 請勿使用含有個人資訊的自訂屬性 用於識別個人身分。

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

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

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

如要瞭解重要指標的變化趨勢，請將這些指標新增至指標資訊板： 「Performance」(效能) 資訊主頁頂端。如要快速找出迴歸問題 或確認程式碼最近的變更 改善成效

如要在指標板中新增指標，請前往「效能」資訊主頁 在 Firebase 控制台中，按一下「資訊主頁」分頁標籤。按一下空白的指標資訊卡，然後選取現有指標，即可新增至看板。按一下產業別 已填入的指標資訊卡上的刪節號 (⋮) 列出更多選項，例如 取代或移除指標

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

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

查看追蹤記錄和相關資料

如要查看追蹤記錄，請前往「效能」資訊主頁 在 Firebase 控制台中，向下捲動至追蹤記錄表格，然後按一下 適當的子分頁表格會顯示每筆追蹤記錄的熱門指標 甚至可以根據特定指標的變化百分比來排序清單。

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

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

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

後續步驟

  • 進一步瞭解 使用屬性來查看成效資料。

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

  • 設定快訊，以因應成效下滑的程式碼變更 應用程式的效能舉例來說，您可以設定 修正特定自訂程式碼追蹤記錄的時間長度超過 門檻值