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

iOS+ Android 網頁版 Flutter

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

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

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

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

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

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

注意： 如果追蹤記錄的啟動和停止速度過快，可能會耗用大量資源，因此請避免以高頻率 (例如在遊戲中每個影格一次) 建立自訂程式碼追蹤記錄。

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

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

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

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

屬性是字串值，可協助您在控制台中篩選及區隔資料。指標是可繪製圖表及評估時間的數值。

新增自訂程式碼追蹤記錄

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

注意事項：

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

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

Web

進一步瞭解樹狀結構可分離模組化 Web API，並升級使用命名空間 API。

import { trace } from "firebase/performance";

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

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

t.stop();
perf_add_custom_trace.js

Web

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

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

trace.stop();
index.js

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

除了 Performance Monitoring Trace API 之外，您也可以使用瀏覽器的原生 User Timing API 新增自訂程式碼追蹤記錄。Performance Monitoring SDK 會自動擷取使用這個 API 所測得的追蹤記錄時間長度。如果您偏好以非同步方式載入 Performance Monitoring SDK，使用 User Timing API 會特別有用。初始化 SDK 後，SDK 會記錄載入前發生的評估。

如要使用這項功能，請將要追蹤的程式碼包裝在使用者時間標記中：

Web

進一步瞭解樹狀結構可分離模組化 Web API，並升級使用命名空間 API。

const performance = window.performance;

performance.mark("measurementStart");

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

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

Web

const performance = window.performance;

performance.mark("measurementStart");

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

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

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

使用 User Timing API 時，無法將自訂指標和屬性新增至自訂程式碼追蹤記錄。如要將這些自訂元素新增至自訂程式碼追蹤記錄，請使用 Performance Monitoring Trace API。

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

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

注意事項：

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

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

Web

進一步瞭解樹狀結構可分離模組化 Web API，並升級使用命名空間 API。

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;
}
perf_add_custom_metrics.js

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;
}
index.js

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

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

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

注意事項：

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

  • 開頭或結尾不得有空白字元，開頭不得有底線 (_) 字元
  • 不能有空格
  • 長度上限為 32 個半形字元
  • 名稱可使用的字元為 A-Z、a-z 和 _。

• 每個自訂程式碼追蹤最多可記錄 5 個自訂屬性。

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

  進一步瞭解這項規範

  收集使用者資料： Performance Monitoring 本身不會收集任何個人識別資訊 (PII)，例如姓名、電子郵件地址或電話號碼。開發人員可以使用 Performance Monitoring 收集其他資料，方法是在自訂程式碼追蹤記錄中建立自訂屬性。透過 Performance Monitoring 收集的這類資料，不應包含可向 Google 提供個人識別資訊的資訊。

  以下是「不含」個人識別資訊的記錄訊息範例：

  trace.putAttribute("experiment", "A");

  以下範例確實包含個人識別資訊 (請勿在應用程式中使用這類自訂屬性)：

  trace.putAttribute("email", user.getEmailAddress());

  我們會在未事先通知的情況下，刪除任何洩漏個人識別資訊的資料。

Web

進一步瞭解樹狀結構可分離模組化 Web API，並升級使用命名空間 API。

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();
perf_add_custom_attributes.js

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();
index.js

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

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

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

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

Firebase Performance Monitoring 資訊主頁" />

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

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

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

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

查看追蹤記錄及其資料

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

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

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

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

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

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

Firebase Performance Monitoring 資料以「/>」屬性篩選

• 依「網頁網址」篩選，查看網站特定網頁的資料
• 依「有效連線類型」篩選，瞭解 3G 連線對應用程式造成的影響
• 依「國家/地區」篩選，確認資料庫位置不會影響特定區域

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

後續步驟

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

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

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