Profiler: Profiler() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Profiler() constructor creates a new Profiler object.

Once created, the new profiler will start collecting samples.

Syntax

js
new Profiler(options)

Parameters

options

Options for this profiler. This is an object containing the following properties:

maxBufferSize

A number indicating the maximum number of samples to take. Once this number is reached, the browser will fire the samplebufferfull event at the profiler, and no more samples will be recorded.

sampleInterval

The time interval between samples, in milliseconds.

Exceptions

RangeError DOMException

Thrown if the sampleInterval option is less than zero.

NotAllowedError DOMException

Thrown if the document was not served with a document policy that included the "js-profiling" configuration point.

Examples

This example creates a profiler which will take up to 1000 samples, sampling every 10 milliseconds.

js
const profiler = new Profiler({ sampleInterval: 10, maxBufferSize: 1000 });

Specifications

Specification
JS Self-Profiling API
# dom-profiler-constructor

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Profiler() constructor
Experimental
Chrome – Full support
Chrome 94 (Release date: 2021-09-21)
footnote Full support
Edge – Full support
Edge 94 (Release date: 2021-09-24)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – Full support
Opera 80 (Release date: 2021-10-05)
footnote Full support
Safari – No support
Safari
footnote No support
Chrome Android – Full support
Chrome Android 94 (Release date: 2021-09-21)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Opera Android – Full support
Opera Android 66 (Release date: 2021-12-15)
footnote Full support
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – Full support
Samsung Internet 17 (Release date: 2022-05-04)
footnote Full support
WebView Android – Full support
WebView Android 94 (Release date: 2021-09-21)
footnote Full support
WebView on iOS – No support
WebView on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.