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


Performance Monitoring 會收集追蹤記錄，協助您監控應用程式效能。A 罩杯 追蹤是系統擷取的

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

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

您可以在程式碼中使用 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-Z、a-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 Monitoring 於 Firebase 控制台提供疑難排解頁面，該頁面會醒目顯示指標 以利快速處理，並盡量減少 應用程式和使用者您可以使用疑難排解頁面，瞭解潛在的效能問題，例如在下列情況下：

  • 您選取資訊主頁上的相關指標，並發現差異很大。
  • 在追蹤記錄表中，您可以排序來顯示最大差異，並查看百分比變化情形。
  • 您會在出現成效問題時收到電子郵件快訊，

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

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

在追蹤記錄表中按一下追蹤記錄名稱，即可深入瞭解感興趣的指標。按一下 「篩選」 按鈕，用於篩選資料 依屬性區分，例如：

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

進一步瞭解 查看您的資料 追蹤記錄。

後續步驟

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

  • 進一步瞭解如何 追蹤成效問題的 Firebase 控制台。

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

  • 查看有關使用者工作階段的詳細報表 您可以查看在時間軸上，查看在相同時間收集到的其他追蹤記錄 會很有幫助