@bbc/web-vitals
v2.3.1
Published
Generic hook for reporting web vitals metrics to an endpoint
Downloads
1,771
Maintainers
Keywords
Readme
Web-Vitals
The WebVitals
utility provides a configurable hook which will collect device capability metrics and Web Vitals metrics for each page view, and then send those metrics to a reporting endpoint when the user leaves the page.
Metrics we report on
Core Web-Vitals
Other data (useful for categorising the web-vitals data received)
FCP (First Contentful Paint)
TTFB (Time To First Byte)
INP (Interaction to Next Paint)
Device Memory
Device CPU
Effective Connection Type
Installation
npm install @bbc/web-vitals --save
Install yarn
The Web Vitals project uses yarn
for package management. It is recommended to install yarn
through the npm package manager, which comes bundled with Node.js when you install it on your system. To install Yarn, run this command:
npm install --global yarn
Props
| Argument | Type | Required | Default | Example |
| ----------------- | -------- | -------- | ----------- | ------------------------------------------------------------- |
| enabled | Boolean | No | false | { enabled: true }
|
| reportingEndpoint | String | Yes | N/A | { reportingEndpoint: 'https://url.to.report.to/analytics' }
|
| loggerCallback | Function | No | () => {}
| { loggerCallback: (error) => console.error(error) }
|
| sampleRate | Integer | No | 100 | { sampleRate: 5 }
|
| reportParams | Object | No | undefined
| { reportParams: { pageType: 'STY' }
|
Usage
The hook can be configured in a number of ways:
enabled
- setting this totrue
will enable sending these metrics to the reporting endpoint. This is so that the reporting functionality can be turned on only when users have agreed to the appropriate privacy and tracking settings where appropriate.reportingEndpoint
- the endpoint you wish to send your metrics tologgerCallback
- a function that will be called whenever an attempt to send the metrics fails.sampleRate
- providing a number between 1-100 will set the percentage of sampling, to prevent overloading the backend reporting server. e.g. asampleRate
of5
will mean that metrics for 5% of requests will be sent to the reporting server.reportParams
- an object that will define query string parameters appended to the reporting endpoint. As an example, providing{ pageType: 'STY' }
will cause?pageType=STY
to be appended to the reporting endpoint.
import useWebVitals from "@bbc/web-vitals";
import logger from "./logger";
const Page = props => {
const enabled = isOnClient() && hasUserAcceptedTracking();
useWebVitals({
enabled,
reportingEndpoint: 'https://url.to.report.to/analytics',
loggerCallback = logger.error,
sampleRate: 50,
reportParams: { pageType: 'STY' },
});
return (
<PageComponents />
);
};
When to use this utility
This utility should ideally be used as close to the top-level of your app as is practical. You should follow due diligence in regards to checking if your site visitor needs to accept any personalisation or tracking permissions under relevant local laws, and use this in determining the value of the enabled
prop.
useEffect
hooks are only run client-side, but when using this hook in combination with Server Side Rendering, you may wish to also include a check of whether the code is running client-side in order to ensure that you do not get inconsistencies between your server's capabilities and the user's.
When not to use this utility
In non-page-level components, especially where these components may be added multiple times to a page.
In situations where users have not provided permission for the relevant personalisation or tracking permissions that may be required under relevant local laws.
Contributing
Web Vitals is completely open source. We are grateful for any contributions, whether they be new utilities, bug fixes or general improvements. Please see our primary contributing guide which can be found at the root of the Web Vitals repository.
Code of Conduct
We welcome feedback and help on this work. By participating in this project, you agree to abide by the code of conduct. Please take a moment to read it.
License
Web-Vitals is Apache 2.0 licensed.