自定义网络请求数据汇总

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 控制台“性能”信息中心底部的跟踪记录表中的“网络请求”子标签中创建自定义网址格式。

项目成员必须是 Owner 或 Editor 才能创建新的自定义网址格式；但是，所有项目成员都可以查看自定义网址格式及其汇总数据。

您可以为每个应用创建最多 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 控制台删除自定义网址格式，而是会在跟踪记录表的“网络请求”子标签的“自定义格式”列表中列出“空”的自定义网址格式。

移除自定义网址格式

您可以从项目中移除自定义网址格式。请注意，您无法移除自动网址格式。

  1. 从“性能”信息中心中，向下滚动到“跟踪记录”表，然后选择“网络请求”子标签。

  2. 从“网络请求”子标签的下拉菜单中选择“自定义格式”。

  3. 将鼠标悬停在您要移除的自定义网址格式的行上。

  4. 点击相应行最右侧的 ，选择“移除自定义格式”，然后在对话框中确认移除。

移除自定义网址格式时，请注意以下事项：

  • 未来的所有请求都会映射到下一个最具体的自定义网址格式匹配。如果 Firebase 找不到自定义网址格式匹配，则会回退为使用自动网址格式匹配。

  • 移除自定义网址格式不会影响过往请求中的匹配项和汇总数据。

    您仍然可以在“网络请求”子标签中访问已移除的自定义网址格式及其汇总数据（在选中“所有网络请求”的情况下），直至相应数据保留期限结束。如果已移除的自定义网址格式下的所有汇总数据都过期，则 Firebase 会删除该自定义网址格式。

  • “网络请求”子标签（在选中“自定义格式”的情况下）不会列出任何已移除的自定义网址格式。

后续步骤

  • 针对会降低应用性能的网络请求设置提醒。例如，如果特定网址格式的响应时间超过您设置的阈值，那么您可以为您的团队配置电子邮件提醒。

自定义如何计算成功率

Firebase 会监控网络请求的成功率。成功率是成功响应次数占总响应次数的百分比。该指标可帮助您衡量网络和服务器故障。

具体来讲，Firebase 会自动将响应代码在 100 - 399 范围内的网络请求计为成功响应。

您可以自定义如何计算成功率，具体方法是将 Firebase 自动计为成功的响应代码以及某些错误代码都计为“成功响应”。

例如，如果您的应用具有搜索端点 API，您就可以将 404 响应计为“成功”，因为 404 响应是搜索端点的一种预期响应。假设此搜索端点每小时有 100 个样本，其中 60 个是 200 响应，40 个是 404 响应。在配置成功率之前，成功率为 60%。将 404 响应配置为成功响应后，成功率将为 100%。

配置成功率计算方式

如需为网络网址格式配置成功率计算方式，您必须具有 firebaseperformance.config.update 权限。默认情况下，以下角色拥有这项必需的权限：Firebase Performance Admin、Firebase Quality Admin、Firebase Admin 和 Project Owner 或 Project Editor。

  1. 前往 Firebase 控制台中的 Performance Monitoring“信息中心”标签页，然后选择要为其配置成功率计算方式的应用。
  2. 向下滚动到屏幕底部的跟踪记录表，然后选择网络请求标签页。
  3. 找到要为其配置成功率计算方式的网址格式。
  4. 打开该行最右侧的溢出菜单（），然后选择配置成功率。
  5. 按照屏幕上的说明选择要将哪些响应代码计为成功响应代码。