In this codelab, you'll learn how to use Firebase Performance Monitoring to measure the performance of a chat web app. Visit https://fireperf-friendlychat.web.app/ to see a live demo.
What you'll learn
- How to add Firebase Performance Monitoring to your web app to get out-of-the-box metrics (page load and network requests).
- How to measure a specific piece of code with custom traces.
- How to record additional, custom metrics tied to a custom trace.
- How to further segment your performance data with custom attributes.
- How to use the performance monitoring dashboard to understand your web app's performance.
What you'll need
Clone the codelab's GitHub repository from the command line:
git clone https://github.com/firebase/codelab-friendlychat-web
Alternatively, if you do not have git installed, you can download the repo as a zip file.
Import the starter app
Using your IDE, open or import the 📁
performance-monitoring-start directory from the cloned repository. This 📁
performance-monitoring-start directory contains the starting code for the codelab, which is a chat web app.
Create a Firebase project
- In the Firebase console, click Add Project.
- Name your Firebase project
Remember the project ID for your Firebase project.
- Click Create Project.
Add a Firebase web app to the project
- Click the web icon to create a new Firebase web app.
- Register the app with the nickname
Friendly Chat, and then check the box next to Also set up Firebase Hosting for this app.
- Click Register app.
- Click through the remaining steps. You don't need to follow the on-screen instructions now; these will be covered in later steps of this codelab.
Enable Google sign-in for Firebase authentication
To allow users to sign in to the chat app with their Google accounts, we'll use the Google sign-in method.
You'll need to enable Google sign-in:
- In the Firebase console, locate the Develop section in the left panel.
- Click Authentication, then click the Sign-in method tab ( go to console).
- Enable the Google sign-in provider, and then click Save.
Enable Cloud Firestore
The web app uses Cloud Firestore to save chat messages and receive new chat messages.
You'll need to enable Cloud Firestore:
- In the Firebase console's Develop section, click Database.
- Click Create database in the Cloud Firestore pane.
- Select the Start in test mode option, then click Enable after reading the disclaimer about the security rules.
The starter code for this codelab includes more secure rules. We'll deploy them later in the codelab.
Enable Cloud Storage
The web app uses Cloud Storage for Firebase to store, upload, and share pictures.
You'll need to enable Cloud Storage:
- In the Firebase console's Develop section, click Storage.
- Click Get Started.
- Read the disclaimer about security rules for your Firebase project, and then click Got it.
The starting code includes a basic security rule, which we'll deploy later in the codelab.
The Firebase command-line interface (CLI) allows you to use Firebase Hosting to serve your web app locally as well as to deploy your web app to your Firebase project.
- Install the CLI by following these instructions in the Firebase docs.
- Verify that the CLI has been installed correctly by running the following command in a terminal:
Make sure that your version of the Firebase CLI is v8.0.0 or later.
- Authorize the Firebase CLI by running the following command:
We've set up the web app template to pull your app's configuration for Firebase Hosting from your app's local directory (the repository that you cloned earlier in the codelab). But to pull the configuration, we need to associate your app with your Firebase project.
- Make sure that your command line is accessing your app's local
- Associate your app with your Firebase project by running the following command:
firebase use --add
- When prompted, select your project ID, and then give your Firebase project an alias.
An alias is useful if you have multiple environments (production, staging, etc). However, for this codelab, let's just use the alias of
- Follow the remaining instructions in your command line.
There are various ways to integrate with the Firebase Performance Monitoring SDK for web (refer to the documentation for details). In this codelab, we'll enable performance monitoring from Hosting URLs.
Add performance monitoring and initialize Firebase
- Open the
public/index.htmlfile, then add the following line below the
TODOto include the Firebase Performance Monitoring SDK.
<!-- TODO: Import the Firebase Performance Monitoring library here. --> <script src="/__/firebase/7.14.2/firebase-performance.js"></script>
- We also need to initialize the Firebase SDK with a configuration object that contains information about the Firebase project and the web app we want to use. Since we're using Firebase Hosting, you can import a special script that will do this configuration for you. For this codelab, we've already added the following line for you at the bottom of the
public/index.htmlfile, but double-check that it is there.
- In the
public/scripts/main.jsfile, add the following line below the
TODOto initialize performance monitoring.
// TODO: Initialize Firebase Performance Monitoring. firebase.performance();
Performance Monitoring will now automatically collect page load and network request metrics for you when users use your site! Refer to the documentation to learn more about automatic page load traces.
Add the first input delay polyfill library
First input delay is useful since the browser responding to a user interaction gives users their first impressions about the responsiveness of your app.
First input delay starts when the user first interacts with an element on the page, like clicking a button or hyperlink. It stops immediately after the browser is able to respond to the input, meaning that the browser isn't busy loading or parsing your content.
This polyfill library is optional for performance monitoring integration.
public/index.html file, then uncomment the following line.
At this point, you've finished the integration with Firebase Performance Monitoring in your code!
In the following steps, you learn about adding custom traces using Firebase Performance Monitoring. If you only want to collect the automatic traces, go to the "Deploy and start sending images" section.
Performance Monitoring allows you to create custom traces. A custom trace is a report for the duration of an execution block in your app. You define the start and end of a custom trace using the APIs provided by the SDK.
- In the
public/scripts/main.jsfile, get a performance object, then create a custom trace for uploading an image message.
// TODO: Create a custom trace to monitor image upload. const trace = firebase.performance().trace('saveImageMessage');
- To record a custom trace, you need to specify the starting point and stopping point for the trace. You can think of a trace as a timer.
// TODO: Start the "timer" for the custom trace. trace.start(); ... // TODO: Stop the "timer" for the custom trace. trace.stop();
You have successfully defined a custom trace! After deploying your code, the duration of the custom trace will be recorded if a user sends an image message. This will give you an idea of how long it takes real-world users to send images in your chat app.
You can further configure a custom trace to record custom metrics for performance-related events that occur within its scope. For example, you can use a metric to investigate if the upload time is affected by the size of an image for the custom trace we defined in the last step.
- Locate the custom trace from the previous step (defined in your
- Add the following line below the
TODOto record the size of the uploaded image.
... // TODO: Record image size. trace.putMetric('imageSize', file.size); ...
This metric enables performance monitoring to record the custom trace duration as well as the uploaded image size.
Building on the previous steps, you can also collect custom attributes on your custom traces. Custom attributes can help in segmenting data by categories specific to your app. For example, you can collect the image file's MIME type to investigate how the MIME type might affect the performance.
- Use the custom trace defined in your
- Add the following line below the
TODOto record the MIME type of the uploaded image.
... // TODO: Record image MIME type. trace.putAttribute('imageType', file.type); ...
This attribute enables performance monitoring to categorize the custom trace duration based on uploaded image type.
The Firebase Performance Monitoring SDK was designed so it could be loaded asynchronously, and so it wouldn't negatively impact the performance of web apps during page load. Before the SDK is loaded, the Firebase Performance Monitoring API is not available. In this scenario, you are still able to add custom traces by using the User Timing API. Firebase performance SDK will pick up the durations from measure() and log them as custom traces.
We are going to measure the duration of loading app styling scripts using User Timing API.
- In the
public/index.htmlfile, add the following line to mark the start of the app styling scripts load.
- Add the following lines to mark the end of the app styling scripts load, and to measure the duration between start and end.
The entry you have created here will be automatically collected by Firebase Performance Monitoring. You will be able to find a custom trace called
loadStyling in the Firebase Performance console later.
Deploy to Firebase Hosting
After adding Firebase Performance Monitoring to your code, follow these steps to deploy your code to Firebase Hosting:
- Make sure that your command line is accessing your app's local
- Deploy your files to your Firebase project by running the following command:
- The console should display the following:
=== 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.appspot.com ✔ 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
- Visit your web app that's now fully hosted using Firebase Hosting at two of your very own Firebase subdomains:
Verify that performance monitoring is enabled
Open Firebase console and go to the Performance tab. If you see a welcome message showing "SDK detected", then you have successfully integrated with Firebase Performance Monitoring!
Send image message
Generate some performance data by sending images in your chat app.
- After signing in to your chat app, click the image upload button .
- Select an image file using the file picker.
- Try sending multiple images (a few samples are stored in
public/images/) so that you can test the distribution of custom metrics and custom attributes.
New messages should display in the app's UI along with your selected images.
After deploying your web app and sending image messages as a user, you can review performance data in the performance monitoring dashboard (in the Firebase console).
Access your dashboard
- In the Firebase console, select the project that has your
- In the left panel, locate the Quality section, and click Performance.
Review on-device data
After performance monitoring has processed your app's data, you'll see tabs along the top of the dashboard. Make sure to check back later if you don't see any data or tabs yet.
- Click the On device tab.
- The Page loads table shows the various performance metrics that performance monitoring automatically collects while your page is loading.
- The Durations table shows any custom traces that you've defined in your app's code.
- Click saveImageMessage in the Durations table to review specific metrics for the trace.
- Click Aggregate to review the distribution of image sizes. You can see the metric you added to measure the image size for this custom trace.
- Click Over time which is next to Aggregate in the previous step. You can also view the Duration of the custom trace. Click View more to review the collected data in more detail.
- In the page which opens, you can segment the duration data by image MIME type by clicking imageType. This specific data was logged because of the imageType attribute you added to your custom trace.
Review network data
An HTTP/S network request is a report that captures the response time and payload size of network calls.
- Go back to the main screen of the performance monitoring dashboard.
- Click the Network tab to see a list of network request entries for your web app.
- Browse through them to identify slow requests and start working on a fix to improve your app's performance!
You have enabled the Firebase SDK for performance monitoring and collected automatic traces and custom traces to measure the real-world performance of your chat app!
What we've covered:
- Adding the Firebase Performance Monitoring SDK to your web app.
- Adding custom traces to your code.
- Recording custom metrics tied to the custom trace.
- Segmenting performance data using custom attributes.
- Understanding how to use the performance monitoring dashboard to gain insights into your app's performance.