效能監控會收集追蹤記錄,協助您監控應用程式效能。追蹤記錄是應用程式在兩個時間點之間擷取的成效資料報表。
您可以建立自己的追蹤記錄,監控與應用程式中特定程式碼相關的成效資料。透過自訂程式碼追蹤記錄,您可以測量應用程式完成特定工作或一組工作所需的時間,例如載入一組圖片或查詢資料庫。
自訂程式碼追蹤記錄的預設指標是「duration」(追蹤記錄開始和停止點之間的時間),但您也可以新增自訂指標。
在程式碼中,您可以使用 Performance Monitoring SDK 提供的 API,定義自訂程式碼追蹤記錄的開頭和結尾。
自訂程式碼追蹤記錄建立後,隨時可以啟動,且具備執行緒安全。
由於系統為這些追蹤記錄收集的預設指標是「duration」,因此有時也稱為「Duration traces」。
您可以在「效能資訊主頁」底部的追蹤記錄表格中,透過「自訂追蹤記錄」子標籤查看這些追蹤記錄的資料 (請參閱本頁後續內容,進一步瞭解如何使用控制台)。
預設屬性、自訂屬性和自訂指標
針對自訂程式碼追蹤,效能監控會自動記錄預設屬性 (常見的中繼資料,例如應用程式版本、國家/地區、裝置等),以便您在 Firebase 控制台中篩選追蹤資料。您也可以新增及監控自訂屬性 (例如遊戲關卡或使用者屬性)。
您可以進一步設定自訂程式碼追蹤記錄,針對追蹤記錄範圍內發生的效能相關事件,記錄自訂指標。舉例來說,您可以建立自訂指標,追蹤快取命中和未命中的次數,或使用者介面明顯沒有回應的次數。
自訂屬性和自訂指標會與追蹤記錄的預設屬性和預設指標,一併顯示在 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();
追蹤、查看及篩選成效資料
在資訊主頁中追蹤特定指標
如要瞭解主要指標的趨勢,請將這些指標新增至「成效」資訊主頁頂端的指標面板。您可以查看每週變化,快速找出迴歸問題,或確認最近的程式碼變更是否提升了成效。
如要在指標面板中新增指標,請前往 Firebase 控制台的「Performance」(效能)資訊主頁 ,然後按一下「Dashboard」(資訊主頁) 分頁標籤。按一下空白指標資訊卡,然後選取要新增至面板的現有指標。按一下已填入資料的指標資訊卡上的垂直刪節號 (⋮),即可查看更多選項,例如取代或移除指標。
指標面板會以圖表和數值百分比變化的形式,顯示一段時間內收集的指標資料。
進一步瞭解如何使用資訊主頁。
查看追蹤記錄和相關資料
如要查看追蹤記錄,請前往 Firebase 控制台的「Performance」資訊主頁,向下捲動至追蹤記錄表格,然後按一下適當的子分頁。表格會顯示每個追蹤記錄的主要指標,您甚至可以依特定指標的百分比變化排序清單。
在追蹤記錄表格中,點選追蹤記錄名稱,即可點選各個畫面,探索追蹤記錄並深入查看感興趣的指標。在大多數頁面上,您可以使用「Filter」(篩選) 按鈕 (位於畫面左上方),依屬性篩選資料,例如:
- 依「應用程式版本」篩選,查看過往版本或最新版本的資料
- 依「裝置」篩選,瞭解舊款裝置如何處理應用程式
- 依「國家/地區」篩選,確保資料庫位置不會影響特定區域
進一步瞭解如何查看追蹤記錄資料。
後續步驟
進一步瞭解如何使用屬性查看成效資料。
進一步瞭解如何在 Firebase 控制台中追蹤效能問題。
設定快訊,在程式碼變更導致應用程式效能降低時通知您。舉例來說,您可以設定電子郵件快訊,在特定自訂程式碼追蹤記錄的持續時間超過您設定的門檻時,通知您的團隊。