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


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

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

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

您可以在程式碼中使用 Performance Monitoring SDK 提供的 API,定義自訂程式碼追蹤的開始和結束時間。 建立自訂程式碼追蹤記錄後,隨時都能啟用, 如何確保執行緒安全

由於這些追蹤記錄的預設指標是「持續時間」,因此不會 有時也稱為「時間長度追蹤記錄」。

您可以在追蹤記錄的「自訂追蹤記錄」子分頁中查看這些追蹤記錄的資料 表格,位於「成效」資訊主頁底部 (進一步瞭解 使用主控台)。

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

針對自訂程式碼追蹤記錄,Performance Monitoring 會自動記錄預設屬性 (常見的中繼資料,例如國家/地區、瀏覽器、網頁網址等),方便您在 Firebase 主控台中篩選追蹤記錄的資料。個人中心 您也可以新增及監控自訂屬性 例如遊戲關卡或使用者屬性。

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

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

新增自訂程式碼追蹤記錄

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

注意事項:

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

如要開始及停止自訂程式碼追蹤記錄,請包裝要查詢的程式碼 其中包含類似以下的程式碼行:

Web

import { trace } from "firebase/performance";

const t = trace(perf, "CUSTOM_TRACE_NAME");
t.start();

// Code that you want to trace 
// ...

t.stop();

Web

const trace = perf.trace("CUSTOM_TRACE_NAME");
trace.start();

// Code that you want to trace 
// ...

trace.stop();

使用 User Timing API 新增自訂程式碼追蹤記錄

除了 Performance Monitoring Trace API 之外,您也可以使用 使用者的原生瀏覽器 User Timing API: 透過這個 API 測量的追蹤記錄時間長度會自動擷取 Performance Monitoring SDK。如果您偏好使用 User Timing API 以非同步方式載入 Performance Monitoring SDKSDK 初始化後,SDK 會記錄載入之前的測量結果。

若要使用這項功能,請用 User Timing 標記包裝想要追蹤的程式碼:

Web

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");

Web

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");

請注意,上述範例中的 performance 是指瀏覽器的 window.performance 物件。

使用 User Timing API 時,無法將自訂指標和屬性新增至 以及執行自訂程式碼追蹤記錄使用 Performance Monitoring Trace API (如要新增自訂) 加入自訂程式碼追蹤記錄中

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

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

注意事項:

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

如要新增自訂指標,請在每次事件發生時,加入類似下方的程式碼行。舉例來說 在應用程式中發生的效能相關事件。

Web

import { trace } from "firebase/performance";

async function getInventory(inventoryIds) {
  const t = trace(perf, "inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  t.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  t.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  t.stop();

  return inventoryData;
}

Web

async function getInventory(inventoryIds) {
  const trace = perf.trace("inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  trace.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  trace.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  trace.stop();

  return inventoryData;
}

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

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

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

注意事項:

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

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

  • 請確認自訂屬性未包含 則代表 Google 會識別個人身分。

    進一步瞭解這項規範

Web

import { trace } from "firebase/performance";

const t = trace(perf, "test_trace");
t.putAttribute("experiment", "A");

// Update scenario
t.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = t.getAttribute("experiment");

// Delete scenario
t.removeAttribute("experiment");

// Read attributes
const traceAttributes = t.getAttributes();

Web

const trace = perf.trace("test_trace");
trace.putAttribute("experiment", "A");

// Update scenario
trace.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = trace.getAttribute("experiment");

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

// Read attributes
const traceAttributes = trace.getAttributes();

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

如要查看即時效能資料,請確認應用程式使用的 Performance Monitoring SDK 版本與即時資料處理相容。進一步瞭解即時成效資料

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

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

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

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

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

指標面板會以圖表形式顯示一段時間內收集到的指標資料 數值百分比的變化

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

查看追蹤記錄及其資料

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

Performance MonitoringFirebase 控制台提供疑難排解頁面,該頁面會醒目顯示指標 以利快速處理,並盡量減少 應用程式和使用者如要瞭解潛在商機,請利用疑難排解頁面 效能問題,如下列情況:

  • 您在資訊主頁上選取相關指標後,發現出現大幅差異。
  • 在追蹤記錄表格中,頂端的差異值最大,且 百分比呈現顯著變化
  • 您會在出現成效問題時收到電子郵件快訊,

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

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

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

<span class=Firebase Performance Monitoring 資料以「/>」屬性篩選
  • 依「網頁網址」篩選,查看網站中特定網頁的資料
  • 依「有效連線類型」篩選,瞭解 3G 連線對應用程式造成的影響
  • 依「國家/地區」篩選,確認資料庫位置不會影響特定區域

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

後續步驟

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

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

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