PerformanceResourceTiming
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.
Note: This feature is available in Web Workers.
The PerformanceResourceTiming interface enables retrieval and analysis of detailed network timing data regarding the loading of an application's resources. An application can use the timing metrics to determine, for example, the length of time it takes to fetch a specific resource, such as an XMLHttpRequest, <SVG>, image, or script.
Description
The interface's properties create a resource loading timeline with high-resolution timestamps for network events such as redirect start and end times, fetch start, DNS lookup start and end times, response start and end times, and more. Additionally, the interface extends PerformanceEntry with other properties which provide data about the size of the fetched resource as well as the type of resource that initiated the fetch.
Typical resource timing metrics
The properties of this interface allow you to calculate certain resource timing metrics. Common use cases include:
- Measuring TCP handshake time (
connectEnd-connectStart) - Measuring DNS lookup time (
domainLookupEnd-domainLookupStart) - Measuring redirection time (
redirectEnd-redirectStart) - Measuring interim request time (
firstInterimResponseStart-requestStart) - Measuring request time (
responseStart-requestStart) - Measuring TLS negotiation time (
requestStart-secureConnectionStart) - Measuring time to fetch (without redirects) (
responseEnd-fetchStart) - Measuring ServiceWorker processing time (
fetchStart-workerStart) - Checking if content was compressed (
decodedBodySizeshould not beencodedBodySize) - Checking if local caches were hit (
transferSizeshould be0) - Checking if modern and fast protocols are used (
nextHopProtocolshould be HTTP/2 or HTTP/3) - Checking if the correct resources are render-blocking (
renderBlockingStatus)
Instance properties
Inherited from PerformanceEntry
This interface extends the following PerformanceEntry properties for resource performance entry types by qualifying and constraining them as follows:
PerformanceEntry.durationRead only-
Returns a
timestampthat is the difference between theresponseEndand thestartTimeproperties. PerformanceEntry.entryTypeRead only-
Returns
"resource". PerformanceEntry.nameRead only-
Returns the resource's URL.
PerformanceEntry.startTimeRead only-
Returns the
timestampfor the time a resource fetch started. This value is equivalent toPerformanceResourceTiming.fetchStart.
Timestamps
The interface supports the following timestamp properties which you can see in the diagram and are listed in the order in which they are recorded for the fetching of a resource. An alphabetical listing is shown in the navigation, at left.
PerformanceResourceTiming.redirectStartRead only-
A
DOMHighResTimeStampthat represents the start time of the fetch which initiates the redirect. PerformanceResourceTiming.redirectEndRead only-
A
DOMHighResTimeStampimmediately after receiving the last byte of the response of the last redirect. PerformanceResourceTiming.workerStartRead only-
Returns a
DOMHighResTimeStampimmediately before dispatching theFetchEventif a Service Worker thread is already running, or immediately before starting the Service Worker thread if it is not already running. If the resource is not intercepted by a Service Worker the property will always return 0. PerformanceResourceTiming.fetchStartRead only-
A
DOMHighResTimeStampimmediately before the browser starts to fetch the resource. PerformanceResourceTiming.domainLookupStartRead only-
A
DOMHighResTimeStampimmediately before the browser starts the domain name lookup for the resource. PerformanceResourceTiming.domainLookupEndRead only-
A
DOMHighResTimeStamprepresenting the time immediately after the browser finishes the domain name lookup for the resource. PerformanceResourceTiming.connectStartRead only-
A
DOMHighResTimeStampimmediately before the browser starts to establish the connection to the server to retrieve the resource. PerformanceResourceTiming.secureConnectionStartRead only-
A
DOMHighResTimeStampimmediately before the browser starts the handshake process to secure the current connection. PerformanceResourceTiming.connectEndRead only-
A
DOMHighResTimeStampimmediately after the browser finishes establishing the connection to the server to retrieve the resource. PerformanceResourceTiming.requestStartRead only-
A
DOMHighResTimeStampimmediately before the browser starts requesting the resource from the server. PerformanceResourceTiming.firstInterimResponseStartExperimental Read only-
A
DOMHighResTimeStampthat represents the interim response time (for example, 100 Continue or 103 Early Hints). PerformanceResourceTiming.responseStartRead only-
A
DOMHighResTimeStampimmediately after the browser receives the first byte of the response from the server. PerformanceResourceTiming.responseEndRead only-
A
DOMHighResTimeStampimmediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first.
Additional resource information
Additionally, this interface exposes the following properties containing more information about a resource:
PerformanceResourceTiming.decodedBodySizeRead only-
A number that is the size (in octets) received from the fetch (HTTP or cache) of the message body, after removing any applied content encoding.
PerformanceResourceTiming.encodedBodySizeRead only-
A number representing the size (in octets) received from the fetch (HTTP or cache), of the payload body, before removing any applied content encodings.
PerformanceResourceTiming.initiatorTypeRead only-
A string representing the web platform feature that initiated the performance entry.
PerformanceResourceTiming.nextHopProtocolRead only-
A string representing the network protocol used to fetch the resource, as identified by the ALPN Protocol ID (RFC7301).
PerformanceResourceTiming.renderBlockingStatusRead only-
A string representing the render-blocking status. Either "
blocking" or "non-blocking". PerformanceResourceTiming.responseStatusExperimental Read only-
A number representing the HTTP response status code returned when fetching the resource.
PerformanceResourceTiming.transferSizeRead only-
A number representing the size (in octets) of the fetched resource. The size includes the response header fields plus the response payload body.
PerformanceResourceTiming.serverTimingRead only-
An array of
PerformanceServerTimingentries containing server timing metrics. PerformanceResourceTiming.deliveryTypeExperimental Read only-
Indicates how the resource was delivered — for example from the cache or from a navigational prefetch.
Instance methods
PerformanceResourceTiming.toJSON()-
Returns a JSON representation of the
PerformanceResourceTimingobject.
Examples
Logging resource timing information
Example using a PerformanceObserver, which notifies of new resource performance entries as they are recorded in the browser's performance timeline. Use the buffered option to access entries from before the observer creation.
const observer = new PerformanceObserver((list) => {
list.getEntries().forEach((entry) => {
console.log(entry);
});
});
observer.observe({ type: "resource", buffered: true });
Example using Performance.getEntriesByType(), which only shows resource performance entries present in the browser's performance timeline at the time you call this method:
const resources = performance.getEntriesByType("resource");
resources.forEach((entry) => {
console.log(entry);
});
Security requirements
Cross-origin timing information
Many of the resource timing properties are restricted to return 0 or an empty string when the resource is a cross-origin request. To expose cross-origin timing information, the Timing-Allow-Origin HTTP response header needs to be set.
For example, to allow https://developer.mozilla.org to see resource timing information, the cross-origin resource should send:
Timing-Allow-Origin: https://developer.mozilla.org
Specifications
| Specification |
|---|
| Resource Timing # resources-included-in-the-performanceresourcetiming-interface |
Browser compatibility
BCD tables only load in the browser