管理已安装的 Firebase Extensions 扩展程序

如需安装或管理扩展程序,您必须拥有以下某个角色:Owner 或 EditorFirebase Admin

列出项目的已安装扩展程序实例

您可以列出已安装的扩展程序的每个实例。

运行 extensions-list 命令:

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

监控已安装的扩展程序实例

在 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 Extensions 扩展程序的 Cloud 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(Cloud Tasks 任务队列)部分。

  3. 点击您要管理的队列对应的查看队列。此操作将打开 Google Cloud 控制台中的“队列详细信息”页面,您可以在其中查看已加入队列的任务、暂停队列、从队列中移除任务,以及执行其他操作。请参阅 Cloud Tasks 文档中的管理队列和任务

查看扩展程序创建的 Cloud Secret Manager 密文

  1. 在 Google Cloud 控制台中打开项目的 Secret Manager 页面。

  2. 在“密文”列表中,您可以查看为 Firebase Extensions 扩展程序创建的密文(以及您为项目创建的任何其他密文)。

    扩展程序创建的密文名称采用以下格式:ext-extension-instance-id-paramnName

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

    密文使用密钥 firebase-extensions-managed 进行标记。除非您希望阻止 Firebase 管理密文,否则请勿移除此标签。

检查已安装的扩展程序运行状况是否正常

您可以在控制台中查看函数(包括 Firebase Extensions 扩展程序创建的函数)的所有错误。

  1. Functions 信息中心的“运行状况”标签页中,您可以简要了解项目中所有函数的错误和性能信息。

  2. 如需查看特定扩展程序的信息,请使用页面顶部的过滤器选择特定函数。

查看已安装扩展程序的运行频率

  1. Functions 信息中心的“信息中心”标签页中,找到您要查看的 Firebase Extensions 扩展程序的特定函数。

  2. 点击条目最右侧的 (溢出菜单),然后选择详细用量统计信息

  3. 在显示的 Google Cloud 控制台中,您可以深入了解对函数的各种调用,甚至检查其源代码。

查看扩展程序的日志

如果您要尝试调试项目或向 Firebase 提交错误报告,那么查看项目中运行的函数的日志会很有帮助。

Functions 信息中心的“日志”标签页中,使用页面顶部的过滤器选择您的扩展程序创建的函数。

将已安装的扩展程序实例更新到最新版本

您可以将已安装的扩展程序实例更新到其最新发布的版本。您可能需要更新已安装的实例,因为实例已在测试、项目或应用工作流中设置或正在运行。

更新实例时,实例的所有扩展程序专用资源和逻辑都将被覆盖,以使用新版源代码和文件。扩展程序的实例 ID 和服务帐号不会更改。

在更新过程中,您会收到新版本的所有更改通知,并且您可以为任何新参数指定值。

  1. 如需将扩展程序清单中的扩展程序实例更新到最新版本,请运行扩展程序更新命令:

    firebase ext:update extensionInstanceId

    如需更新到特定版本,请指定要更新到的版本:

    firebase ext:update extensionInstanceId versionNumber
  2. 接下来,如需将清单中的扩展程序部署到 Firebase 项目,请运行以下命令:

    firebase deploy --only extensions --project=projectId-or-alias

重新配置已安装的扩展程序实例

您可以为已安装的扩展程序实例更改用户配置的参数值。将来触发此实例时,系统会使用这些新值,但扩展程序之前创建的所有工件或结构元素(如存储的图片或现有存储桶)均不会更改。

  1. 如需在扩展程序清单中以交互方式重新配置扩展程序,请运行扩展程序配置命令:

    firebase ext:configure extensionInstanceId
  2. 接下来,如需将清单中的扩展程序部署到 Firebase 项目,请运行以下命令:

    firebase deploy --only extensions --project=projectId-or-alias

卸载扩展程序实例

您可以从 Firebase 项目中卸载扩展程序实例。此操作会删除 Firebase 为该扩展程序实例专门创建的服务帐号和所有资源(如一组函数)。但以下各项不会被删除:

  • 扩展程序创建的任何工件(如存储的图片)。

  • 项目中的任何其他资源,例如数据库实例或 Cloud Storage 存储桶。即使扩展程序与这些其他资源进行了交互,这些资源也并非特定于扩展程序,因此在扩展程序卸载后不会被删除。

扩展程序的卸载方法如下:

  1. 如需从扩展程序清单中移除扩展程序实例,请运行扩展程序卸载命令:

    firebase ext:uninstall extensionInstanceId
  2. 接下来,如需将对清单做出的更改部署到 Firebase 项目,请运行以下命令:

    firebase deploy --only extensions --project=projectId-or-alias