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


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

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

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

您可以在程式碼中使用 Performance Monitoring SDK 提供的 API,定義自訂程式碼追蹤的起點和終點。 自訂程式碼追蹤記錄建立後,就能隨時啟動,而且符合執行緒安全規範。

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

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

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

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

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

自訂屬性和自訂指標會顯示在 Firebase 控制台中,以及追蹤記錄的預設屬性和預設指標。

新增自訂程式碼追蹤記錄

使用 Performance Monitoring Trace API (Swift | Obj-C) 新增自訂程式碼追蹤記錄,以監控特定應用程式程式碼。

注意事項:

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

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

Swift

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
// Add the Performance Monitoring module to your header
import FirebasePerformance

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

// code that you want to trace

trace.stop()

Objective-C

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
// Add the Performance Monitoring module to your header
@import FirebasePerformance;

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

// code that you want to trace

[trace stop];

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

使用 Performance Monitoring Trace API (Swift | Obj-C),將自訂指標新增至自訂程式碼追蹤記錄中。

注意事項:

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

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

Swift

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.incrementMetric(named:"EVENT_NAME", by: 1)
// code that you want to trace (and log custom metrics)

trace.stop()

Objective-C

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace incrementMetric:@"EVENT_NAME" byInt:1];
// code that you want to trace (and log custom metrics)

[trace stop];

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

使用 Performance Monitoring Trace API (Swift | Obj-C) 將自訂屬性新增至自訂程式碼追蹤記錄。

如要使用自訂屬性,請在應用程式中加入用來定義屬性的程式碼,並將其與特定自訂程式碼追蹤記錄建立關聯。您可以在追蹤開始和停止期間的任何時間設定自訂屬性。

注意事項:

  • 自訂屬性名稱必須符合下列規定:

    • 開頭或結尾不得有空白字元,開頭不得有底線 (_) 字元
    • 不能有空格
    • 長度上限為 32 個半形字元
    • 名稱可使用的字元包括 A-Za-z_
  • 每個自訂程式碼追蹤記錄最多可記錄 5 個自訂屬性。

  • 請確認自訂屬性不含任何 Google 可識別個人身分的資訊。

    進一步瞭解這項規範

Swift

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.setValue("A", forAttribute: "experiment")

// Update scenario.
trace.setValue("B", forAttribute: "experiment")

// Reading scenario.
let experimentValue:String? = trace.valueForAttribute("experiment")

// Delete scenario.
trace.removeAttribute("experiment")

// Read attributes.
let attributes:[String, String] = trace.attributes;

Objective-C

注意:這項 Firebase 產品不適用於 macOS、Mac Catalyst 和 watchOS 目標。
FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace setValue:@"A" forAttribute:@"experiment"];

// Update scenario.
[trace setValue:@"B" forAttribute:@"experiment"];

// Reading scenario.
NSString *experimentValue = [trace valueForAttribute:@"experiment"];

// Delete scenario.
[trace removeAttribute:@"experiment"];

// Read attributes.
NSDictionary <NSString *, NSString *> *attributes = [trace attributes];

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

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

如要瞭解重要指標的趨勢,請將這些指標新增至 成效資訊主頁頂端的指標看板。您可以查看逐週變化,或確認近期程式碼變更是否有助於提升效能,藉此快速找出迴歸問題。

<span class=Firebase Performance Monitoring 資訊主頁" />

如要將指標新增至指標看板,請按照下列步驟操作:

  1. 前往 Firebase 主控台的「效能」資訊主頁
  2. 按一下空白的指標資訊卡,然後選取要新增至看板的現有指標。
  3. 在已填入資料的指標資訊卡上按一下 ,即可查看更多選項,例如取代或移除指標。

指標板會顯示收集到的指標資料,包括圖形和數字百分比變化。

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

查看追蹤記錄和相關資料

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

Performance MonitoringFirebase 控制台中提供疑難排解頁面,醒目顯示指標變化,方便您快速解決問題,並盡量減少效能問題對應用程式和使用者的影響。您可以透過疑難排解頁面瞭解潛在的效能問題,例如在下列情況下使用:

  • 您選取資訊主頁上的相關指標,並發現差異很大。
  • 在追蹤記錄表中,您可以排序來顯示最大差異值,並查看百分比變化幅度。
  • 您會收到電子郵件快訊,通知您有效能問題。

您可以透過下列方式存取疑難排解頁面:

  • 在指標資訊主頁上,按一下「查看指標詳細資料」按鈕。
  • 在任何指標資訊卡上,依序選取「」>「查看詳細資料」。疑難排解頁面會顯示所選指標的相關資訊。
  • 在追蹤記錄表中,按一下與該追蹤記錄相關聯的列中任一指標值或追蹤記錄名稱。
  • 在電子郵件快訊中,按一下「立即調查」

在追蹤記錄表中按一下追蹤記錄名稱,即可深入瞭解感興趣的指標。按一下「篩選器」按鈕,即可按屬性篩選資料,例如:

<span class=依屬性篩選 Firebase Performance Monitoring 資料" />
  • 依「應用程式版本」篩選,查看過去或最新版本的資料
  • 依「裝置」篩選,瞭解舊版裝置如何處理您的應用程式
  • 依「國家/地區」篩選,確認資料庫位置不會影響特定區域

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

後續步驟

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

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

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

  • 查看使用者工作階段的詳細報表,透過時間軸內容,查看同一個工作階段期間收集到的其他追蹤記錄中的特定追蹤記錄。