监控使用情况

本页面介绍如何监控 Firestore 使用量和发现应用中的潜在问题。了解应用的使用量还可以让您大致了解帐单上可能有哪些费用。此外,如果有些地方看起来不大正常,清楚地了解数据库的操作情况可能是一个有用的排查途径。

使用情况信息中心

Google Cloud Console 和 Firebase 控制台包含一个 Firestore 使用情况信息中心,其中会显示在一段时间内执行的读取、写入和删除操作。

Cloud Console

转到 Firestore 使用情况页面 (Cloud Console)

Cloud Console 中的 Firestore 使用情况信息中心。

访问权限控制机制

使用情况信息中心需要 monitoring.timeSeries.list IAM 权限。项目所有者、编辑者和查看者角色会授予此权限。您还可以通过 Cloud Monitoring 角色自定义角色授予此权限。

Firebase 控制台

转到 Firestore 使用情况页面(Firebase 控制台)

Firebase 控制台中的 Firestore 使用情况信息中心。

安全规则使用情况

此外,Firebase 控制台还提供安全规则评估信息中心,这是一种实用的服务,可让您对规则调用一目了然。如果您觉得此信息中心中的内容不够详细,可以参阅 Cloud Monitoring 中的详细分析。

转到“规则”页面

Firebase 控制台中的 Firestore 规则监控信息中心。

每日配额

Cloud Console 中的 App Engine 配额页面跟踪每天的 Firestore 使用量信息,包括读取次数、写入次数、索引写入次数、删除次数、存储数据和网络出站流量。

转到“配额”页面

“App Engine 配额”页面中的 Firestore 使用量。

Cloud Monitoring

Cloud Monitoring 会从 Google Cloud 产品中收集指标、事件和元数据。Firestore 控制台中的使用情况信息中心会报告相同的指标数据。要设置自定义信息中心和使用情况提醒,请使用 Cloud Monitoring。

Cloud Monitoring 包括以下 Firestore 指标:

指标名称 说明
文档读取次数

成功读取文档的次数。您可以按以下读取类型来细分该指标:LOOKUP 或 QUERY。

此指标不包括来自托管式导出服务的读取操作。

文档写入次数

成功写入文档的次数。您可以按以下写入类型来细分该指标:CREATE 或 UPDATE。

此指标不包括来自托管式导入服务的写入操作。

文档删除次数 成功删除文档的次数。
活跃连接数

与数据库建立的活跃连接数。

每个活跃的移动 SDK 和 Web SDK 都会保持一个连接,该连接可在多个快照侦听器之间共享。服务器客户端库会为每个快照监听器创建一个连接。

快照侦听器数

所有活跃连接的快照监听器数量。

规则评估

为响应写入或读取请求而执行的 Firestore 规则评估的次数。您可以按请求结果(ALLOW、DENY 或 ERROR)来细分该指标。

实时更新用量

可使用“活跃连接数”和“快照侦听器数”指标来衡量您的实时更新用量。

假设某个用户在手机上打开了您的应用,随后将该应用连接到 Firestore 并订阅 10 个查询。此时,您的指标会增加 1 个活跃连接和 10 个快照侦听器。

采样率

系统每分钟都会对 Firestore 指标进行一次采样,但更新信息最多可能需要 4 分钟才会显示在信息中心内。

您可以使用这些指标设置 Firestore 信息中心,如下所示:

Cloud Monitoring 信息中心中的 Firestore 使用量。

完成以下步骤后,您就可以开始使用 Cloud Monitoring 监控 Firestore 了。

创建 Cloud Monitoring 工作区

如需使用 Cloud Monitoring 监控 Firestore,您必须为项目设置一个工作区。工作区会整理一个或多个项目的监控信息。设置完工作区后,您可以创建自定义信息中心和提醒政策。

  1. 打开 Cloud Monitoring 页面

    如果您的项目已经属于某个工作区,则系统会打开 Cloud Monitoring 页面。否则,请为项目选择工作区。

  2. 选择新工作区 (New Workspace) 选项或选择现有工作区。

  3. 点击添加 (Add)。构建工作区后,系统会打开 Cloud Monitoring 页面。

创建信息中心并添加图表

在您自己的图表和信息中心内显示通过 Cloud Monitoring 收集的 Firestore 指标。

在继续之前,请确保您的项目已经属于某个 Cloud Monitoring 工作区

  1. 在 Cloud Monitoring 页面中,打开工作区并转到信息中心 (Dashboards) 页面。

    转到“信息中心”页面

  2. 点击创建信息中心 (Dashboards),然后输入信息中心名称。

  3. 在右上角,点击添加图表 (Add Chart)。

  4. 添加图表 (Add Chart) 窗口中,输入图表标题。点击指标标签页。

  5. 查找资源类型和指标字段中,输入 Firestore。从自动填充的下拉列表中选择一个 Firestore 指标。

  6. 要向同一图表添加更多指标,请点击添加指标,然后重复以上步骤。

  7. 根据需要,自定义您的图表。例如,在 Filter 字段中,点击 + Add a filter。向下滚动,然后为希望作为图表过滤依据的相关指标选择一个值或范围。

  8. 点击保存 (Save)。

如需详细了解 Cloud Monitoring 图表,请参阅使用图表

创建提醒政策

您可以根据 Firestore 指标创建提醒政策。 按下列步骤操作即可创建以下提醒政策:只要具体的 Firestore 指标达到特定阈值,您就会收到电子邮件。

在继续之前,请确保您的项目已经属于某个 Cloud Monitoring 工作区

  1. 在 Cloud Monitoring 页面中,打开工作区,然后转到提醒 (Alerting) 页面。

    转到“Create New Alerting Policy”页面

  2. 点击创建政策 (Create Policy)。

  3. 输入您的提醒政策的名称。

  4. 根据其中一个 Firestore 指标添加提醒发出条件。点击添加条件

  5. 选择一个目标。在查找资源类型和指标字段中,输入 Firestore。从自动填充的下拉列表中选择一个 Firestore 指标。

  6. 政策触发器下,使用下拉字段定义提醒发出条件。

  7. 向提醒政策中添加通知渠道。在通知 (Notifications) 下,点击添加通知渠道 (Add Notification Channel)。从下拉菜单中选择电子邮件 (Email)。

  8. 电子邮件地址 (Email address) 字段中输入您的电子邮件地址。点击添加 (Add)。

  9. (可选)填写文档字段,以在电子邮件通知中包含其他信息。

  10. 点击保存

如果您的 Firestore 使用量超过配置的阈值,您将收到电子邮件提醒:Firestore 提醒电子邮件示例。

如需详细了解提醒政策,请参阅提醒简介

后续步骤