管理已安裝的 Firebase Extensions

如要安裝或管理擴充功能,您必須具備下列任一角色:擁有者或編輯者Firebase 管理員


列出專案已安裝的擴充功能執行個體

您可以列出已安裝擴充功能的所有執行個體。

執行擴充功能清單指令:

firebase ext:list --project=projectId-or-alias

查看已安裝擴充功能執行個體的詳細資料和設定

  1. 前往 Firebase 控制台的 Firebase Extensions 資訊主頁

  2. 在已安裝的擴充功能例項資訊卡上,按一下「管理」

監控已安裝的擴充功能執行個體

您可以在 Firebase 控制台中監控已安裝擴充功能的活動,包括檢查其健康狀態、使用情形和記錄。

設定預算快訊

一般來說,設定預算快訊是良好的做法,但如果您信任其他人會在專案中執行程式碼,那麼快訊就特別重要。

請務必為 Firebase 專案設定預算快訊

查看擴充功能建立的函式

  1. 前往 Firebase 控制台的「Functions 資訊主頁」

  2. 您可以在「資訊主頁」分頁中查看 Firebase Extensions 的函式 (以及為專案部署的任何其他函式)。

    擴充功能建立的函式會有名稱,格式如下: ext-extension-instance-id-functionName

    例如:ext-awesome-task-simplifier-onUserCreate

查看擴充功能建立的 Cloud Scheduler 工作

  1. Google Cloud 控制台中開啟專案的 Cloud Scheduler 頁面。

  2. 在工作清單中,您可以查看 Firebase ExtensionsCloud Scheduler 工作 (以及您為專案建立的任何其他工作),

    擴充功能建立的工作名稱格式為:firebase-ext-extension-instance-id-functionName

    例如:firebase-ext-awesome-task-simplifier-doTask

查看及管理由擴充功能排入佇列的 Cloud Tasks

部分擴充功能會使用 Cloud Tasks 執行較長時間的工作:最常見的是處理在擴充功能生命週期中不同時間點執行的工作,例如安裝、重新設定和升級後。

通常,這些工作會自動執行並完成,無需您介入。不過,如果您需要手動管理擴充功能的佇列工作 (例如暫停佇列或從佇列中移除尚未開始的工作),請按照下列步驟操作:

  1. Firebase 控制台的「Extensions」 部分,開啟擴充功能執行個體的詳細資料頁面。

  2. 在詳細資料頁面中,開啟「API 和資源」部分。如果擴充功能使用 Cloud Tasks,就會有「Cloud Task queues」專區,其中包含一或多個項目。

  3. 針對您要管理的佇列按一下「查看佇列」。這麼做會在 Google Cloud 主控台中開啟「Queue Details」(佇列詳細資料) 頁面,您可以在其中查看佇列中的任務、暫停佇列、從佇列中移除任務等等。請參閱 Cloud Tasks 說明文件中的「管理佇列和工作」。

查看擴充功能建立的 Cloud Secret Manager 密鑰

  1. Google Cloud 主控台中開啟專案的 Secret Manager 頁面。

  2. 在「Secrets」(密鑰) 清單中,您可以查看為 Firebase Extensions 建立的密鑰 (以及您為專案建立的任何其他密鑰)。

    擴充功能建立的密鑰名稱格式為:ext-extension-instance-id-paramnName

    例如:ext-awesome-task-simplifier-API_KEY

    密鑰會標上 firebase-extensions-managed 金鑰。除非您想停止 Firebase 管理密鑰,否則請勿移除這個標籤。

檢查已安裝的擴充功能是否健康狀態良好

您可以在控制台中查看函式 (包括 Firebase Extensions 建立的) 所有錯誤。

  1. 「Functions」資訊主頁的「Health」分頁中,您可以查看專案中所有函式的錯誤和效能資訊總覽。

  2. 如要查看特定擴充功能的資訊,請使用頁面頂端的篩選器選取特定函式。

查看已安裝的擴充功能執行的頻率

  1. 函式資訊主頁的「資訊主頁」分頁中,找出要檢查的 Firebase Extension 對應的特定函式。

  2. 按一下項目最右側的 (溢位選單),然後選取「詳細使用統計資料」

  3. 在顯示的 Google Cloud 控制台中,您可以細查函式的各種叫用,甚至檢查其原始碼。

查看擴充功能的記錄

如果您要對專案進行偵錯,或向 Firebase 提交錯誤報告,建議您查看專案中執行的函式記錄。

在「函式資訊主頁」的「記錄檔」分頁中,使用頁面頂端的篩選器選取擴充功能建立的函式。

將已安裝的擴充功能執行個體更新至最新版本

您可以將已安裝的擴充功能例項更新至最新發布版本。建議您更新已安裝的執行個體,因為執行個體已在測試、專案或應用程式工作流程中已主動執行或設定。

更新執行個體時,系統會覆寫所有執行個體的擴充功能專屬資源和邏輯,以便使用新版本的原始碼和檔案。擴充功能的執行個體 ID 和服務帳戶不會變更。

更新過程中,系統會通知您新版本的任何變更,您也可以為任何新參數指定值。

  1. 前往 Firebase Extensions 資訊主頁,然後在已安裝的擴充功能例項資訊卡上,按一下「管理」

  2. 按一下右上角的「更新擴充功能」

    如果擴充功能沒有可用的新版本,詳細資料頁面就不會顯示更新按鈕。

  3. 查看更新內容,並視需要設定擴充功能。

  4. 按一下「更新擴充功能」

重新設定已安裝的擴充功能執行個體

您可以針對已安裝的擴充功能執行個體,變更使用者設定的參數值。這些新值會用於執行個體的任何未來觸發事件,但擴充功能先前建立的所有構件或結構元素 (例如已儲存的圖片或現有儲存空間儲存桶) 都不會受到影響。

  1. 前往 Firebase Extensions 資訊主頁,然後在已安裝的擴充功能執行個體資訊卡上,按一下「管理」

  2. 按一下右上角的「重新設定擴充功能」

  3. 按照畫面上的指示重新設定擴充功能的參數值。

  4. 按一下 [儲存]

解除安裝擴充功能執行個體

您可以從 Firebase 專案中解除安裝擴充功能的例項。這項操作會刪除服務帳戶,以及 Firebase 專為該擴充功能執行個體建立的所有資源 (例如一組函式)。不過,下列項目不會遭到刪除:

  • 擴充功能建立的所有構件,例如已儲存的圖片。

  • 專案中的任何其他資源,例如資料庫執行個體或 Cloud Storage 值區。即使擴充功能與這些其他資源互動,但這些資源並非擴充功能專屬,因此在解除安裝擴充功能後,這些資源不會遭到刪除。

解除安裝擴充功能的方法如下:

  1. 前往 Firebase Extensions 資訊主頁,然後在已安裝的擴充功能例項資訊卡上按一下「管理」

  2. 按一下畫面底部的「解除安裝擴充功能」

  3. 查看要刪除的項目,然後按一下「解除安裝擴充功能」確認刪除。