PerformanceResourceTiming

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.

PerformanceEntry PerformanceResourceTiming

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 request time (responseStart - requestStart)
  • Measuring SSL negotiation time (requestStart - secureConnectionStart)
  • Measuring time to fetch (without redirects) (responseEnd - fetchStart)
  • Measuring ServiceWorker processing time (fetchStart - workerStart)
  • Checking if content was compressed (decodedBodySize should not be encodedBodySize)
  • Checking if local caches were hit (transferSize should be 0)
  • Checking if modern and fast protocols are used (nextHopProtocol should 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.duration Read only

Returns a timestamp that is the difference between the responseEnd and the startTime properties.

PerformanceEntry.entryType Read only

Returns "resource".

PerformanceEntry.name Read only

Returns the resource's URL.

PerformanceEntry.startTime Read only

Returns the timestamp for the time a resource fetch started. This value is equivalent to PerformanceResourceTiming.fetchStart.

Timestamps

The interface supports the following timestamp properties which you can see in the diagram and 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.

Timestamp diagram listing timestamps in the order in which they are recorded for the fetching of a resource

PerformanceResourceTiming.redirectStart Read only

A DOMHighResTimeStamp that represents the start time of the fetch which initiates the redirect.

PerformanceResourceTiming.redirectEnd Read only

A DOMHighResTimeStamp immediately after receiving the last byte of the response of the last redirect.

PerformanceResourceTiming.workerStart Read only

Returns a DOMHighResTimeStamp immediately before dispatching the FetchEvent if 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.fetchStart Read only

A DOMHighResTimeStamp immediately before the browser starts to fetch the resource.

PerformanceResourceTiming.domainLookupStart Read only

A DOMHighResTimeStamp immediately before the browser starts the domain name lookup for the resource.

PerformanceResourceTiming.domainLookupEnd Read only

A DOMHighResTimeStamp representing the time immediately after the browser finishes the domain name lookup for the resource.

PerformanceResourceTiming.connectStart Read only

A DOMHighResTimeStamp immediately before the browser starts to establish the connection to the server to retrieve the resource.

PerformanceResourceTiming.secureConnectionStart Read only

A DOMHighResTimeStamp immediately before the browser starts the handshake process to secure the current connection.

PerformanceResourceTiming.connectEnd Read only

A DOMHighResTimeStamp immediately after the browser finishes establishing the connection to the server to retrieve the resource.

PerformanceResourceTiming.requestStart Read only

A DOMHighResTimeStamp immediately before the browser starts requesting the resource from the server.

PerformanceResourceTiming.responseStart Read only

A DOMHighResTimeStamp immediately after the browser receives the first byte of the response from the server.

PerformanceResourceTiming.responseEnd Read only

A DOMHighResTimeStamp immediately 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.decodedBodySize Read 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.encodedBodySize Read 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.initiatorType Read only

A string representing the type of resource that initiated the performance entry.

PerformanceResourceTiming.nextHopProtocol Read only

A string representing the network protocol used to fetch the resource, as identified by the ALPN Protocol ID (RFC7301).

PerformanceResourceTiming.renderBlockingStatus Read only

A string representing the render-blocking status. Either "blocking" or "non-blocking".

PerformanceResourceTiming.responseStatus Experimental Read only

A number representing the HTTP response status code returned when fetching the resource.

PerformanceResourceTiming.transferSize Read 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.serverTiming Read only

An array of PerformanceServerTiming entries containing server timing metrics.

Instance methods

PerformanceResourceTiming.toJSON()

Returns a JSON representation of the PerformanceResourceTiming object.

Examples

Logging resource timing information

Here's an example using a PerformanceObserver, which notifies of new resource performance entries as they are recorded in the browser's performance timeline:

const observer = new PerformanceObserver((list) => {
  list.getEntries().forEach((entry) => {
    console.log(entry);
  });
});

observer.observe({ type: "resource", buffered: true });

Here's an 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

See also