Repository files navigation

Page Speed is a feature, and to deliver it we need to understand the many factors and fundamental limitations that are at play. If we can measure it, we can improve it.

Perfume is a tiny, web performance monitoring library that reports field data back to your favorite analytics tool.

• ⏰ Supports latest Performance APIs for precise metrics
• 🚀 Device data enrichment
• 🔨 Cross browser tested
• 🚿 Filters out false positive/negative results
• 🤙 Only 5.1Kb gzip
• 🏅 Web Vitals Score
• 🛰 Flexible analytics tool
• ⚡️ Waste-zero ms withrequestIdleCallback strategy built-in
• Ability to track data about user actions
  

Perfume leverages the latest Performance APIs to collectfield data that allows us to understand what real-world users are actually experiencing.

• Navigation Timing
• Navigator Interface
• Resource Timing
• Element Timing
• Service Worker Status
• StorageManager interface
• Time to First Byte (TTFB)
• First Contentful Paint (FCP)
• Largest Contentful Paint (LCP)
• First Input Delay (FID)
• Cumulative Layout Shift (CLS)
• Interaction to Next Paint (INP)
• Total Blocking Time (TBT)
• Navigation Total Blocking Time (NTBT)

Perfume leverages theWeb Vitals library to collect all the standardized performance metrics. It explores new metrics like Navigation Total Blocking Time and dimensions like Low-End Devices, Service Worker status to understand your data better.

So don't worry, Perfume.js is a superset of Web Vitals, a bit like Typescript is a superset of Javascript.

npm (https://www.npmjs.com/package/perfume.js):

npm install perfume.js --save

You can import the generated bundle to use the whole library generated:

import{initPerfume}from'perfume.js';

Universal Module Definition:

import{initPerfume}from'node_modules/perfume.js/dist/perfume.umd.min.js';

Metrics likeNavigation Timing,Network Information,TTFB,FCP,FID,LCP,CLS,INP andTBT are default reported with Perfume; All results will be reported to theanalyticsTracker callback, and the code below is just one way for you to organize your tracking, feel free to tweak it suit your needs.

🚀 Visithttps://zizzamia.github.io/perfume/ for a live demo on how the metrics work. 🌕

import{initPerfume}from'perfume.js';initPerfume({analyticsTracker:options=>{const{      attribution,      metricName,      data,      navigatorInformation,      rating,      navigationType,}=options;switch(metricName){case'navigationTiming':if(data&&data.timeToFirstByte){myAnalyticsTool.track('navigationTiming',data);}break;case'networkInformation':if(data&&data.effectiveType){myAnalyticsTool.track('networkInformation',data);}break;case'storageEstimate':myAnalyticsTool.track('storageEstimate',data);break;case'TTFB':myAnalyticsTool.track('timeToFirstByte',{duration:data});break;case'RT':myAnalyticsTool.track('redirectTime',{duration:data});break;case'FCP':myAnalyticsTool.track('firstContentfulPaint',{duration:data});break;case'FID':myAnalyticsTool.track('firstInputDelay',{duration:data});break;case'LCP':myAnalyticsTool.track('largestContentfulPaint',{duration:data});break;case'CLS':myAnalyticsTool.track('cumulativeLayoutShift',{value:data});break;case'INP':myAnalyticsTool.track('interactionToNextPaint',{value:data});break;case'TBT':myAnalyticsTool.track('totalBlockingTime',{duration:data});break;case'elPageTitle':myAnalyticsTool.track('elementTimingPageTitle',{duration:data});break;case'userJourneyStep':myAnalyticsTool.track('userJourneyStep',{duration:data,stepName:attribution.step_name,vitals_score:rating,});break;default:myAnalyticsTool.track(metricName,{duration:data});break;}},});

In a world with widely varying device capabilities, a one-size-fits-all event doesn’t always work. Perfume addsdata enrichment to all events so we can better understand the real world experiences:

• deviceMemory: the user's device memory (RAM).
• hardwareConcurrency: the number of logical CPU processor cores on the user's device.
• serviceWorkerStatus: status of the service worker between controlled, supported and unsupported.

Based on the Navigator APIs the library can help us differentiate between a low-end and a high-end device/experience:

• isLowEndDevice: combination of the score of RAM and CPU.
• isLowEndExperience: combination of the score of RAM, CPU, NetworkStatus and SaveData.

Coo coo coocool, let's learn something new.

Navigation Timing collects performance metrics for the life and timings of a network request.

Perfume helps expose some of the key metrics you might need.

• Redirect time: Page redirects aren't totally inconsequential, but they might not be something you run into very often. Still, redirects add latency to requests, so measuring them may be worth the effort.
• DNS lookup: When a user requests a URL, the Domain Name System (DNS) is queried to translate a domain to an IP address.
• Header size: HTTP header size
• Fetch time: Cache seek plus response time
• Worker time: Service worker time plus response time
• Total time: Request plus response time (network only)
• Download time: Response time only (download)
• Time to First Byte: The amount of time it takes after the client sends an HTTP GET request to receive the first byte of the requested resource from the server. It is the largest web page load time component taking 40 to 60% of total web page latency.

// Perfume.js: navigationTiming { ... timeToFirstByte: 192.65 }

FP is the exact time taken for the browser to render anything as visually different from what was on the screen before navigation, e.g. a background change after a long blank white screen time.

// Perfume.js: fp 1482.00 ms

This metric measures the amount of time the application may be blocked from processing code during the 2s window after a user navigates from page A to page B. The NTBT metric is the summation of the blocking time of all long tasks in the 2s window after this method is invoked.

Because this library is navigation agnostic, we have this method to mark when the navigation starts.

If this method is called before the 2s window ends; it will trigger a new NTBT measurement and interrupt the previous one.

import{createBrowserHistory}from'history';exportconsthistory=createBrowserHistory();initPerfume({analyticsTracker:({ metricName, data})=>{myAnalyticsTool.track(metricName,data);})});// React custom historyhistory.listen(()=>{// Measure NTBT at the beginning of each navigationperfume.markNTBT();});// Perfume.js: ntbt 78 ms

Resource Timing collects performance metrics for document-dependent resources. Stuff like style sheets, scripts, images, et cetera.Perfume helps expose all PerformanceResourceTiming entries and groups data data consumption by Kb used.

initPerfume({resourceTiming:true,analyticsTracker:({ metricName, data})=>{myAnalyticsTool.track(metricName,data);})});// Perfume.js: dataConsumption { "css": 185.95, "fetch": 0, "img": 377.93, ... , "script": 8344.95 }

Performance.mark (User Timing API) is used to create an application-defined peformance entry in the browser's performance entry buffer.

import{start,end}from'perfume.js';initPerfume({analyticsTracker:({ metricName, data})=>{myAnalyticsTool.track(metricName,data);})});start('fibonacci');fibonacci(400);end('fibonacci');// Perfume.js: fibonacci 0.14 ms

Track when image elements and text nodes are displayed on screen using theemergingElement Timing API specification by simply adding theelementtiming attribute with a descriptive value of your choice to HTML elements you would like to measure:

<h1elementtiming="elPageTitle"class="title">Perfume.js</h1><imgelementtiming="elHeroLogo"alt="Perfume.js logo"src="https://zizzamia.github.io/perfume/assets/perfume-logo-v5-0-0.png"/>

initPerfume({elementTiming:true,analyticsTracker:({ metricName, data})=>{myAnalyticsTool.track(metricName,data);})});// Perfume.js: elPageTitle 256.00 ms// Perfume.js: elHeroLogo 1234.00 ms

A Step represents a slice of time in the User Journey where the user is blocked bysystem time. System time is time the system is blocking the user. For example, the time it takes to navigate between screens or fetch critical information from the server. This should not be confused withcognitive time, which is the time the user spends thinking about what to do next. User Journey steps should only cover system time.

A Step is defined by an event to start the step, and another event to end the step. These events are referred to asMarks.

As an example, a Step could be to navigate from screen A to screen B. The appropriate way to mark a start and end to this step is by marking the start when tapping on the button on screen A that starts the navigation and marking the end when screen B comes into focus with the critical data rendered on the screen.

// Marking the start of the stepconstScreenA=()=>{consthandleNavigation=()=>{    ...// Navigation logic// Mark when navigating to screen BmarkStep('navigate_to_screen_B');}...return(<><ButtononPress={handleNavigation}/></>);}// Marking the end of the stepconstScreenB=()=>{const{ viewer}=fetch("http://example.com/userInfo").then((response)=>response.json()).then((data)=>data);const{name}=viewer.userProperties;useEffect(()=>{if(name){// Mark when data is ready for screen BmarkStep('loaded_screen_B');}},[name])...}

In order for Perfume to be able to track metrics for Steps, we need to configure the steps and provide them when initializing Perfume.

Below you can find an example of how to do this.

exportconststeps={load_screen_A:{threshold:ThresholdTier.quick,marks:['navigate_to_screen_A','loaded_screen_A'],},load_screen_B:{threshold:ThresholdTier.quick,marks:['navigate_to_screen_B','loaded_screen_B'],},};initPerfume({ steps});

markStep is the function used to start and end steps in applications.

For example, if we wanted to mark the beginning of load_screen_B step above, we would add inmarkStep('navigate_to_screen_B') to our code.

The purpose of this function is to only account for active steps that the user is working on. The feature will remove any inactive or 'stale' steps that are not currently in progress.

Stale steps can be created by navigating away from a page before it fully loads, this would cause the start mark to be triggered, but the end mark to not be called. This would affect theactive steps being returned toonMarkStep as well as would create incorrect data if we returned back to the end mark much later than expected.

ThetrackUJNavigation function is to be called anytime there is a navigation change in your application. Below is an example for how this would work in a React Application:

import{useLocation}from'react-router-dom';constMyComponent=()=>{constlocation=useLocation()React.useEffect(()=>{// runs on location, i.e. route, changetrackUJNavigation();},[location])...}

Perfume will expose for all major metrics the vitals score, those can be used to improve yourSEO and Google page rank.

Step Tracking is based on variousthresholds defined.

Below are the thresholds available for each step:

Default options provided to Perfume.js constructor.

constoptions={resourceTiming:false,elementTiming:false,analyticsTracker:options=>{},maxMeasureTime:30000,enableNavigtionTracking:true,};

A quick way to see your page speed results on your web app is by using Google Analytics. Those GA events will show on Behavior > Site Speed > User Timings. For testing you might want to see them coming live on Realtime > Events.

Have fun ✨

constmetricNames=['TTFB','RT','FCP','LCP','FID','CLS','TBT'];initPerfume({analyticsTracker:({ attribution, metricName, data, navigatorInformation, rating, navigationType})=>{if(metricNames.includes(metricName)){ga('send','event',{eventCategory:'Perfume.js',eventAction:metricName,// Google Analytics metrics must be integers, so the value is roundedeventValue:metricName==='cls' ?data*1000 :data,eventLabel:navigatorInformation.isLowEndExperience ?'lowEndExperience' :'highEndExperience',// Use a non-interaction event to avoid affecting bounce ratenonInteraction:true,});}})});

To connect with additional analytics providers, checkout theanalytics plugin for Perfume.js.

• npm run test: Run test suite
• npm run build: Generate bundles and typings
• npm run lint: Lints code
  

• Perfume.js plugin for Analytics
  

• Conio
• Coinbase
• Coinbase Pro
• Coinbase Custody
• Financial-Times
• Hearst
• Plan
• Add your company name :)
  

Made with ☕️ by@zizzamia andI want to thank some friends and projects for the work they did:

• Leraging the Performance Metrics that Most Affect User Experience for documenting this new User-centric performance metrics;ev
• Performance Timeline Level 2 the definition ofPerformanceObserver in that specification;
• The Contributors for their much appreciated Pull Requests and bug reports;
• you for the star you'll give this project 😉 and for supporting me by giving my project a try 😄

This project exists thanks to all the people who contribute.

Thank you to all our backers! 🙏 [Become a backer]

Code and documentation copyright 2022Leonardo Zizzamia. Code released under theMIT license. Docs released under Creative Commons.

Leonardo Zizzamia