将 Firebase Performance Monitoring 用于 Web

1. 概览

在此 Codelab 中，您将了解如何使用 Firebase Performance Monitoring 衡量 Web 聊天应用的性能。欢迎访问 https://fireperf-friendlychat.web.app/ 查看演示应用。

3b1284f5144b54f6.png

学习内容

  • 如何将 Firebase Performance Monitoring 添加到 Web 应用，以获取开箱即用的指标（网页加载和网络请求）。
  • 如何使用自定义跟踪记录衡量特定代码段。
  • 如何记录与自定义跟踪记录相关联的其他自定义指标。
  • 如何使用自定义属性进一步细分效果数据。
  • 如何使用性能监控信息中心了解 Web 应用的性能。

您需要满足的条件

  • 您选择的 IDE 或文本编辑器，例如 WebStorm、Atom、Sublime 或 VS Code
  • 终端/控制台
  • 您所选的浏览器（例如 Chrome）
  • 此 Codelab 的示例代码（如需了解如何获取代码，请参阅本 Codelab 的下一部分）。

2. 获取示例代码

通过命令行克隆此 Codelab 的 GitHub 代码库：

git clone https://github.com/firebase/codelab-friendlychat-web

或者，如果您尚未安装 git，可以以 zip 文件的形式下载代码库。

导入 starter 应用

使用 IDE 打开或从克隆的代码库导入 📁? performance-monitoring-start 目录。此 📁? performance-monitoring-start 目录包含此 Codelab 的起始代码，即一个聊天网络应用。

3. 创建和设置 Firebase 项目

创建 Firebase 项目

  1. 在 Firebase 控制台中，点击添加项目。
  2. 将您的 Firebase 项目命名为 FriendlyChat。

记住您的 Firebase 项目的项目 ID。

  1. 点击创建项目。

升级您的 Firebase 定价方案

如需使用 Cloud Storage for Firebase，您的 Firebase 项目必须采用随用随付 (Blaze) 定价方案，这意味着该项目已与一个 Cloud Billing 账号相关联。

  • Cloud Billing 账号要求提供付款方式，例如信用卡。
  • 如果您刚开始接触 Firebase 和 Google Cloud，请确认您是否有资格获得 $300 赠金和免费试用 Cloud Billing 账号。
  • 如果您是在某个活动中学习本 Codelab，请询问组织者是否有 Cloud 抵用金。

如需将项目升级到 Blaze 方案，请按以下步骤操作：

  1. 在 Firebase 控制台中，选择升级您的方案。
  2. 选择 Blaze 方案。按照屏幕上的说明将 Cloud Billing 账号与您的项目相关联。
    如果您需要在此升级过程中创建 Cloud Billing 账号，则可能需要返回 Firebase 控制台中的升级流程以完成升级。

向项目添加 Firebase Web 应用

  1. 点击 Web 图标 58d6543a156e56f9.png 以创建新的 Firebase Web 应用。
  2. 使用别名 Friendly Chat 注册应用，然后选中还为此应用设置 Firebase Hosting 旁边的复选框。
  3. 点击注册应用。
  4. 点击浏览其余步骤。您现在无需按照屏幕上的说明操作；此 Codelab 的后续步骤将介绍这些说明。

ea9ab0db531a104c.png

为 Firebase Authentication 启用 Google 登录

为了允许用户使用其 Google 账号登录聊天应用，我们将使用 Google 登录方法。

您需要启用 Google 登录：

  1. 在 Firebase 控制台中，在左侧面板中找到开发部分。
  2. 点击身份验证，然后点击登录方法标签页（前往控制台）。
  3. 启用 Google 登录服务提供方，然后点击保存。

7f3040a646c2e502.png

设置 Cloud Firestore

Web 应用使用 Cloud Firestore 保存聊天消息并接收新聊天消息。

如需在 Firebase 项目中设置 Cloud Firestore，请按以下步骤操作：

  1. 在 Firebase 控制台的左侧面板中，展开构建，然后选择 Firestore 数据库。
  2. 点击创建数据库。
  3. 将数据库 ID 设置为 (default)。
  4. 为数据库选择一个位置，然后点击下一步。
    对于真实应用，您需要选择靠近用户的位置。
  5. 点击以测试模式启动。阅读有关安全规则的免责声明。
    在本 Codelab 的后面部分，您将添加安全规则来保护您的数据。在没有为数据库添加安全规则的情况下，请不要公开分发或公开应用。
  6. 点击创建。

设置 Cloud Storage for Firebase

Web 应用使用 Cloud Storage for Firebase 存储、上传和分享图片。

如需在 Firebase 项目中设置 Cloud Storage for Firebase，请按以下步骤操作：

  1. 在 Firebase 控制台的左侧面板中，展开构建，然后选择存储。
  2. 点击开始使用。
  3. 为默认的 Storage 存储分区选择位置。
    US-WEST1、US-CENTRAL1 和 US-EAST1 中的存储分区可以使用 Google Cloud Storage 的“始终免费”层级。所有其他位置的存储分区均遵循 Google Cloud Storage 价格和使用量。
  4. 点击以测试模式启动。阅读有关安全规则的免责声明。
    在本 Codelab 的后面部分，您将添加安全规则来保护您的数据。在未为您的存储桶添加安全规则的情况下，请不要公开分发或公开应用。
  5. 点击创建。

4. 安装 Firebase 命令行界面

借助 Firebase 命令行界面 (CLI)，您可以使用 Firebase Hosting 在本地提供 Web 应用，以及将 Web 应用部署到 Firebase 项目。

  1. 按照 Firebase 文档中的这些说明安装 CLI。
  2. 在终端中运行以下命令，验证 CLI 是否已正确安装：
firebase --version

确保 Firebase CLI 版本为 v8.0.0 或更高版本。

  1. 通过运行以下命令向 Firebase CLI 授权：
firebase login

我们已设置 Web 应用模板，以便从应用的本地目录（您之前在 Codelab 中克隆的代码库）中提取应用的 Firebase Hosting 配置。但要拉取配置，我们需要将您的应用与 Firebase 项目相关联。

  1. 确保命令行可以访问应用的本地 performance-monitoring-start 目录。
  2. 通过运行以下命令，将您的应用与 Firebase 项目相关联：
firebase use --add
  1. 出现提示时，选择您的项目 ID，然后为您的 Firebase 项目指定一个别名。

如果您有多个环境（生产、预演等），别名会非常有用。不过，在此 Codelab 中，我们直接使用 default 这个别名。

  1. 请按照命令行中的其余说明进行操作。

5. 与 Firebase Performance Monitoring 集成

您可以通过多种方式与 Firebase Performance Monitoring SDK for Web 集成（如需了解详情，请参阅文档）。在此 Codelab 中，我们将通过托管网址启用性能监控。

添加 Performance Monitoring 并初始化 Firebase

  1. 打开 src/index.js 文件，然后在 TODO 下方添加以下行，以添加 Firebase Performance Monitoring SDK。

index.js

// TODO: Import the Firebase Performance Monitoring library here.
 import {
   getPerformance,
   trace
 } from 'firebase/performance';
  1. 我们还需要使用包含 Firebase 项目和要使用的 Web 应用的相关信息的配置对象初始化 Firebase SDK。由于我们使用的是 Firebase Hosting，因此您可以导入一个特殊脚本，该脚本会为您完成此配置。在此 Codelab 中，我们已在 public/index.html 文件底部为您添加了以下代码行，但请仔细检查是否已添加。

index.html

<!-- This script is created by webpack -->
<script type="module" src="scripts/main.js"></script>
  1. 在 src/index.js 文件中，在 TODO 下方添加以下行，以初始化性能监控。

index.js

// TODO: Initialize Firebase Performance Monitoring.
getPerformance();

现在，当用户使用您的网站时，Performance Monitoring 会自动为您收集网页加载和网络请求指标！参阅文档，详细了解自动网页加载轨迹。

添加 First Input Delay polyfill 库

首次输入延迟很有用，因为浏览器对用户互动做出响应决定了用户对应用的响应速度的第一印象。

首次输入延迟从用户首次与页面上的元素交互（例如点击按钮或超链接）时开始。浏览器能够响应输入（意味着浏览器不忙于加载或解析您的内容）后立即停止。

此 polyfill 库是性能监控集成的可选项。

打开 public/index.html 文件，然后取消注释以下行。

index.html

<!-- TODO: Enable First Input Delay polyfill library. -->
<script type="text/javascript">!function(n,e){var t,o,i,c=[],f={passive:!0,capture:!0},r=new Date,a="pointerup",u="pointercancel";function p(n,c){t||(t=c,o=n,i=new Date,w(e),s())}function s(){o>=0&&o<i-r&&(c.forEach(function(n){n(o,t)}),c=[])}function l(t){if(t.cancelable){var o=(t.timeStamp>1e12?new Date:performance.now())-t.timeStamp;"pointerdown"==t.type?function(t,o){function i(){p(t,o),r()}function c(){r()}function r(){e(a,i,f),e(u,c,f)}n(a,i,f),n(u,c,f)}(o,t):p(o,t)}}function w(n){["click","mousedown","keydown","touchstart","pointerdown"].forEach(function(e){n(e,l,f)})}w(n),self.perfMetrics=self.perfMetrics||{},self.perfMetrics.onFirstInputDelay=function(n){c.push(n),s()}}(addEventListener,removeEventListener);</script>

至此，您已在代码中完成与 Firebase Performance Monitoring 的集成！

在以下步骤中，您将了解如何使用 Firebase Performance Monitoring 添加自定义轨迹。如果您只想收集自动轨迹，请前往“部署并开始发送图片”部分。

6. 向应用添加自定义轨迹

借助 Performance Monitoring，您可以创建自定义轨迹。自定义跟踪记录是应用中某个执行块的持续时间报告。您可以使用 SDK 提供的 API 指定自定义跟踪记录的开始和结束时间。

  1. 在 src/index.js 文件中，获取一个性能对象，然后创建用于上传图片消息的自定义轨迹。

index.js

// TODO: Create custom trace to monitor image upload.
const t = trace(perf, "saveImageMessage");
  1. 如需记录自定义轨迹，您需要指定轨迹的起点和终点。您可以将轨迹视为计时器。

index.js

// TODO: Start the "timer" for the custom trace.
t.start();

 ...

    // TODO: Stop the "timer" for the custom trace.
    t.stop();

您已成功定义自定义轨迹！部署代码后，如果用户发送图片消息，系统会记录自定义轨迹的持续时间。这样，您就可以了解真实用户在您的聊天应用中发送图片需要多长时间。

7. 向应用添加自定义指标。

您可以进一步配置自定义跟踪记录，以记录在其范围内发生的性能相关事件的自定义指标。例如，您可以使用指标来调查上传时间是否受我们在上一步中定义的自定义轨迹的图片大小影响。

  1. 找到上一步中自定义轨迹（在 src/index.js 文件中定义）。
  2. 在 TODO 下方添加以下代码行，以记录上传图片的大小。

index.js

 ...

// TODO: Record image size.
t.putMetric('imageSize', file.size);

 ...

启用此指标后，性能监控功能会记录自定义轨迹时长以及上传的图片大小。

8. 向应用添加自定义属性

在前面的步骤的基础上，您还可以针对自定义跟踪记录收集自定义属性。自定义属性有助于按适用于您的应用的类别细分数据。例如，您可以收集图片文件的 MIME 类型，以调查 MIME 类型可能会对性能产生哪些影响。

  1. 使用 src/index.js 文件中定义的自定义轨迹。
  2. 在 TODO 下方添加以下代码行，以记录上传图片的 MIME 类型。

index.js

 ...

// TODO: Record image MIME type.
t.putAttribute('imageType', file.type);

 ...

借助此属性，Performance Monitoring 可以根据上传的图片类型对自定义轨迹时长进行分类。

9. [扩展] 使用 User Timing API 添加自定义跟踪记录

Firebase Performance Monitoring SDK 的设计可实现异步加载，因此不会对网页加载期间 Web 应用的性能产生负面影响。在 SDK 加载之前，Firebase Performance Monitoring API 不可用。在这种情况下，您仍然可以使用 User Timing API 添加自定义跟踪记录。Firebase Performance SDK 会从 measure() 中提取时长，并将其记录为自定义轨迹。

我们将使用 User Timing API 衡量加载应用样式脚本所需的时间。

  1. 在 public/index.html 文件中，添加以下代码行，以标记应用样式脚本加载的开始。

index.html

<!-- TODO: Mark the starting of `timer` for loading App Styling script. -->
<script type="text/javascript">performance && performance.mark('loadStylingStart');</script>
  1. 添加以下代码行，以标记应用样式脚本加载结束，并测量开始和结束之间的时长。

index.html

<!-- TODO: Mark the ending of `timer` for loading App Styling script. Measure the duration from start to end. -->
<script type="text/javascript">
  performance && performance.mark('loadStylingEnd');
  performance && performance.measure('loadStyling', 'loadStylingStart', 'loadStylingEnd');
</script>

Firebase Performance Monitoring 会自动收集您在此处创建的条目。稍后，您将能够在 Firebase Performance 控制台中找到名为 loadStyling 的自定义轨迹。

10. 部署并开始发送图片

部署到 Firebase Hosting

将 Firebase Performance Monitoring 添加到代码后，请按照以下步骤将代码部署到 Firebase Hosting：

  1. 确保命令行可以访问应用的本地 performance-monitoring-start 目录。
  2. 运行以下命令，将文件部署到 Firebase 项目：
firebase deploy
  1. 控制台应显示以下内容：
=== Deploying to 'friendlychat-1234'...

i  deploying firestore, storage, hosting
i  storage: checking storage.rules for compilation errors...
✔  storage: rules file storage.rules compiled successfully
i  firestore: checking firestore.rules for compilation errors...
✔  firestore: rules file firestore.rules compiled successfully
i  storage: uploading rules storage.rules...
i  firestore: uploading rules firestore.rules...
i  hosting[friendlychat-1234]: beginning deploy...
i  hosting[friendlychat-1234]: found 8 files in ./public
✔  hosting[friendlychat-1234]: file upload complete
✔  storage: released rules storage.rules to firebase.storage/friendlychat-1234.firebasestorage.app
✔  firestore: released rules firestore.rules to cloud.firestore
i  hosting[friendlychat-1234]: finalizing version...
✔  hosting[friendlychat-1234]: version finalized
i  hosting[friendlychat-1234]: releasing new version...
✔  hosting[friendlychat-1234]: release complete

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com
  1. 访问您的 Web 应用，该应用现在完全托管在您的两个 Firebase 子网域：https://<projectId>.firebaseapp.com 和 https://<projectId>.web.app。

验证是否已启用性能监控

打开 Firebase 控制台，然后前往性能标签页。如果您看到显示“已检测到 SDK”的欢迎消息，则表示您已成功集成 Firebase Performance Monitoring！

30df67e5a07d03b0.png

发送图片消息

在聊天应用中发送图片，以生成一些性能数据。

  1. 登录聊天应用后，点击图片上传按钮 13734cb66773e5a3.png。
  2. 使用文件选择器选择图片文件。
  3. 尝试发送多个图片（其中一些示例存储在 public/images/ 中），以便测试自定义指标和自定义属性的分布情况。

新消息应随所选图片一起显示在应用界面中。

11. 监控信息中心

部署 Web 应用并以用户身份发送图片消息后，您可以在性能监控信息中心（在 Firebase 控制台中）查看性能数据。

访问信息中心

  1. 在 Firebase 控制台中，选择包含 Friendly Chat 应用的项目。
  2. 在左侧面板中，找到质量部分，然后点击效果。

查看设备上的数据

性能监控处理完应用的数据后，您会在信息中心顶部看到一些标签页。如果您还没有看到任何数据或标签页，请务必稍后再回来查看。

  1. 点击“基于设备”标签页。
  • “网页加载”表格会显示 Performance Monitoring 在网页加载期间自动收集的各种性能指标。
  • “时长”表会显示您在应用代码中定义的所有自定义轨迹。
  1. 点击时长表中的 saveImageMessage 可查看该轨迹的具体指标。

e28758fd02d9ffac.png

  1. 点击汇总可查看图片尺寸的分布情况。您可以看到为衡量此自定义轨迹的图片大小而添加的指标。

c3cbcfc0c739a0a8.png

  1. 点击上一步中汇总旁边的一段时间内的变化。您还可以查看自定义轨迹的时长。点击展开可更详细地查看收集的数据。

16983baa31e05732.png

  1. 在随即打开的页面中，您可以点击 imageType，按图片 MIME 类型细分时长数据。由于您向自定义轨迹添加了 imageType 属性，因此系统记录了这些具体数据。

8e5c9f32f42a1ca1.png

查看网络数据

“HTTP/S 网络请求”报告会捕获网络调用的响应时间和载荷大小。

  1. 返回效果监控信息中心的主屏幕。
  2. 点击 Network 标签页，查看 Web 应用的网络请求条目列表。
  3. 浏览这些请求，找出运行缓慢的请求，然后着手解决问题，以提升应用的性能！

26a2be152a77ffb9.png

12. 恭喜！

您已启用用于性能监控的 Firebase SDK，并收集了自动跟踪记录和自定义跟踪记录，以衡量聊天应用的实际性能！

我们已介绍的内容：

  • 将 Firebase Performance Monitoring SDK 添加到您的 Web 应用。
  • 向代码添加自定义跟踪记录。
  • 记录与自定义轨迹相关联的自定义指标。
  • 使用自定义属性细分效果数据。
  • 了解如何使用性能监控信息中心深入了解应用的性能。

了解详情：