PerformanceObserver.observe()

The observe() method of the PerformanceObserver interface is used to specify the set of performance entry types to observe. The performance entry types are specified as an array of DOMString objects, each naming one entry type; the type names are documented in Performance entry type names in PerformanceEntry.entryType.

When a matching performance entry is recorded, the performance observer's callback function—set when creating the PerformanceObserver—is invoked.

Syntax

observer.observe(options);

Parameters

options
A PerformanceObserverInit dictionary with one member:
  • "entryTypes", an array of DOMString objects, each specifying one performance entry type to observe. See PerformanceEntry.entryType for a list of valid type name. Unrecognized types are ignored, though the browser may output a warning message to the console to help developers debug their code. If no valid types are found, observe() has no effect.

Example

This example creates and configures two PerformanceObservers; one watches for "mark" and "frame" events, and the other watches for "measure" events.

var observer = new PerformanceObserver(function(list, obj) {
  var entries = list.getEntries();
  for (var i=0; i < entries.length; i++) {
    // Process "mark" and "frame" events
  }
});
observer.observe({entryTypes: ["mark", "frame"]});

function perf_observer(list, observer) {
  // Process the "measure" event 
}
var observer2 = new PerformanceObserver(perf_observer);
observer2.observe({entryTypes: ["measure"]});

Specifications

Specification Status Comment
Performance Timeline Level 2
The definition of 'observe()' in that specification.
Candidate Recommendation Initial definition of observe() method.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support52 ?57 No3911
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No52 ?573911 ?

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, jpmedley, chrisdavidmills, teoli, rolfedh, AFBarstow
Last updated by: Sheppy,