自訂網路要求資料匯總作業

Firebase Performance Monitoring 會自動匯總類似網路要求的資料,協助您瞭解網路要求效能的趨勢。

不過,有時您需要自訂 Firebase 匯總特定網路要求資料的方式,才能更妥善地支援應用程式的用途。我們提供兩種方式,讓您自訂網路要求的資料匯總:匯總自訂網址模式下的資料,以及自訂成功率的計算方式。

匯總自訂網址模式下的資料

Firebase 會檢查每個網路要求的網址是否符合網址模式。如果要求網址符合網址模式,Firebase 會自動將要求的資料匯總到該網址模式下。

您可以建立自訂網址模式,監控 Firebase 透過衍生的自動網址模式比對功能無法擷取的特定網址模式。舉例來說,您可以使用自訂網址模式排解特定網址的問題,或長期監控一組特定網址。

Firebase 會在追蹤記錄表格的「網路要求」子分頁中,顯示所有網址模式 (包括自訂網址模式) 及其 匯總資料。這個表格位於 Firebase 控制台「 效能資訊主頁」的底部。

自訂網址模式比對的運作方式為何?

Firebase 會先嘗試將要求網址與任何設定的自訂網址模式進行比對,然後才改用自動網址模式比對。對於符合自訂網址模式的任何要求,Firebase 會在自訂網址模式下匯總要求的資料。

如果要求的網址與多個自訂網址模式相符,Firebase 只會根據下列明確程度順序,將要求對應至最明確的自訂網址模式:純文字 > * > ** (在路徑中由左至右)。舉例來說,對 example.com/books/dog 的要求符合兩個自訂網址模式:

  • example.com/books/*
  • example.com/*/dog

不過,模式 example.com/books/* 是「最明確」的比對網址模式,因為 example.com/books/* 中最左側的區段 books 優先於 example.com/*/dog 中最左側的區段 *。

建立新的自訂網址模式時,請注意下列事項:

  • 建立新的自訂網址模式,不會影響先前要求的比對結果和匯總資料。Firebase 不會追溯重新匯總要求資料。

  • 建立新的自訂網址模式只會影響未來的要求。您可能需要等待最多 12 小時,Performance Monitoring 才會根據新的自訂網址模式收集及匯總資料。

建立自訂網址模式

您可以在 Firebase 控制台的「效能資訊主頁」底部,從追蹤記錄表格的「網路要求」子標籤建立自訂網址模式。

專案成員必須是擁有者或編輯者,才能建立新的自訂網址模式;不過,所有專案成員都可以查看自訂網址模式及其匯總資料。

每個應用程式最多可建立 400 個自訂網址模式,每個網域最多可建立 100 個自訂網址模式。

如要建立自訂網址模式,請先輸入主機名稱,再輸入路徑區隔。主機名稱必須包含有效的網域,並可視需要包含子網域。請使用下列路徑區隔語法,建立可比對網址的模式。

  • 純文字:比對完全一致的字串
  • *:比對第一個子網域區隔,或單一路徑區隔中的任何字串
  • **:比對任意路徑後置字串

下表說明一些可能的自訂網址模式比對。

比對條件 建立自訂網址模式,例如… 符合這個網址模式的範例
確切網址 example.com/foo/baz example.com/foo/baz
任何單一路徑區隔 (*) example.com/*/baz example.com/foo/baz
example.com/bar/baz
example.com/*/*/baz example.com/foo/bar/baz
example.com/bah/qux/baz
example.com/foo/* example.com/foo/baz
example.com/foo/bar

注意:這個模式不適用於 example.com/foo。

任意路徑後置字串 (**) example.com/foo/** example.com/foo
example.com/foo/baz
example.com/foo/baz/more/segments
subdomain.example.com/foo.bar/** subdomain.example.com/foo.bar
subdomain.example.com/foo.bar/baz
subdomain.example.com/foo.bar/baz/more/segments
第一個子網域區隔 (*) *.example.com/foo bar.example.com/foo
baz.example.com/foo

查看自訂網址模式及其資料

Firebase 會在追蹤記錄表格的「網路要求」子分頁中,顯示所有網址模式 (包括自訂網址模式) 及其 匯總資料。這個表格位於 Firebase 控制台「 效能資訊主頁」的底部。

如要「只」查看自訂網址模式,請在追蹤記錄表格的「網路要求」子分頁中,從下拉式選單選取「自訂模式」。請注意,如果自訂網址模式沒有任何匯總資料,就只會顯示在這份清單中。

當網址模式下匯總資料的資料保留期限結束時,Firebase 會從網址模式中刪除該資料。如果自訂網址模式下匯總的所有資料都已過期,Firebase 不會從 Firebase 控制台刪除該自訂網址模式。Firebase 會繼續在追蹤記錄表的「網路要求」子分頁中,將「空白」自訂網址模式列在「自訂模式」清單中。

移除自訂網址模式

您可以從專案中移除自訂網址模式。請注意,您無法移除自動網址模式。

  1. 在「Performance」(效能) 資訊主頁中,向下捲動至追蹤記錄表格,然後選取「Network requests」(網路要求) 子分頁。

  2. 在「網路要求」子分頁的下拉式選單中,選取「自訂模式」。

  3. 將滑鼠游標懸停在要移除的自訂網址模式資料列上。

  4. 按一下該列最右側的 ,選取「Remove custom pattern」(移除自訂模式),然後在對話方塊中確認移除。

移除自訂網址模式時,請注意下列事項:

  • 未來的所有要求都會對應至次具體的比對自訂網址模式。如果 Firebase 找不到相符的自訂網址模式,就會改用自動網址模式比對。

  • 移除自訂網址模式不會影響先前要求的比對結果和匯總資料。

    在適用的資料保留期限結束前,您仍可在「Network requests」(網路要求) 子分頁 (已選取「All network requests」(所有網路要求)) 中,存取已移除的自訂網址模式及其匯總資料。當已移除的自訂網址模式下所有匯總資料都過期時,Firebase 就會刪除該自訂網址模式。

  • 「網路要求」子分頁 (已選取「自訂模式」) 不會列出任何已移除的自訂網址模式。

後續步驟

  • 設定快訊,在網路要求降低應用程式效能時通知您。舉例來說,您可以設定電子郵件快訊,在特定網址模式的回應時間超過設定的門檻時,通知團隊。

自訂成功率計算方式

Firebase 會監控每項網路要求的指標,其中一項是要求的成功率。成功率是指成功回應占總回應數的百分比。這項指標有助於評估網路和伺服器故障。

具體來說,Firebase 會自動將回應代碼介於 100 至 399 之間的網路要求視為成功回應。

除了 Firebase 自動計為成功的回應代碼外,您也可以將特定錯誤代碼計為「成功回應」,自訂成功率計算方式。

舉例來說,如果應用程式有搜尋端點 API,您可以將 404 回應視為「成功」,因為搜尋端點預期會傳回 404 回應。假設這個搜尋端點每小時有 100 個樣本,其中 60 個是 200 回應,40 個是 404 回應。設定成功率之前,成功率會是 60%。將成功率計算方式設為將 404 回應計為成功後,成功率就會是 100%。

設定成功率計算方式

如要設定網路網址模式的成功率計算方式,您必須具備 firebaseperformance.config.update 權限。下列角色預設包含這項必要權限:Firebase 效能管理員、Firebase 品質管理員、Firebase 管理員,以及專案擁有者或編輯者。

  1. 前往 Firebase 控制台的「Performance Monitoring 資訊主頁分頁」,然後選取要設定成功率計算方式的應用程式。
  2. 向下捲動至畫面底部的追蹤記錄表格,然後選取「Network requests」(網路要求) 分頁標籤。
  3. 找出要設定成功率計算方式的網址模式。
  4. 開啟該列最右側的溢位選單 (),然後選取「Configure success rate」(設定成功率)。
  5. 按照畫面上的指示,選取要視為成功的回應代碼。