Skip to content

Instantly share code, notes, and snippets.

Last active April 3, 2024 07:41
Show Gist options
  • Save bvaughn/8de925562903afd2e7a12554adcdda16 to your computer and use it in GitHub Desktop.
Save bvaughn/8de925562903afd2e7a12554adcdda16 to your computer and use it in GitHub Desktop.
Interaction tracing with React

This API was removed in React 17

Interaction tracing with React

React recently introduced an experimental profiler API. After discussing this API with several teams at Facebook, one common piece of feedback was that the performance information would be more useful if it could be associated with the events that caused the application to render (e.g. button click, XHR response). Tracing these events (or "interactions") would enable more powerful tooling to be built around the timing information, capable of answering questions like "What caused this really slow commit?" or "How long does it typically take for this interaction to update the DOM?".

With version 16.4.3, React added experimental support for this tracing by way of a new NPM package, scheduler. However the public API for this package is not yet finalized and will likely change with upcoming minor releases, so it should be used with caution.

This Gist provides some high-level documentation for anyone looking to experiment with the API.

WARNING: "unstable_" APIs may change in any version without respecting semver

React has always respected semantic versioning for its public API. However, sometimes we want to share an early preview of something that is likely to change in the future. This is one of those cases. If you care about semantic versioning guarantees, don't use "unstable_" APIs because they are subject to change in any patch release. If you use them, you agree that things will break between releases, and that you use a lockfile to avoid that.

Note that if you're using a version of react/react-dom that's less than 16.6, you should refer to this earlier revision of the documentation instead.

Note that if you're using the schedule package v0.3.0-v0.4.0 you should refer to this earlier revision of the documentation instead.


An interaction is a descriptive string (e.g. "login button clicked") and a timestamp. When you declare an interaction, you also provide a callback in which to do some work related to that interaction. Interactions are similar to "zones" in that any work done within the "zone" is attributed to the interaction.

For example, you can trace a React render like so:

import { unstable_Profiler as Profiler } from "react";
import { render } from "react-dom";
import { unstable_trace as trace } from "scheduler/tracing";

trace("initial render",, () =>
    <Profiler id="Application" onRender={onRender}>
      <Application />

In the above example, the profiler's onRender prop will be called after the application renders and mounts. Among other things, it will receive a parameter that specifies the Set of interactions that were part of that render (i.e. the "initial render" interaction).

The interaction will also appear in the React DevTools profiler plug-in.


The following methods are a subset of the interaction tracing API.


  name: string,
  timestamp: number,
  callback: () => T
) => T

Traces a new interaction (by appending to the existing set of interactions). The callback function will be executed and its return value will be returned to the caller. Any code run within that callback will be attributed to that interaction. Calls to unstable_wrap() will schedule async work within the same zone.


unstable_wrap(callback: Function) => Function

Wrap a function for later execution within the current interaction "zone". When this function is later run, interactions that were active when it was "wrapped" will be reactivated.

The wrapped function returned also defines a cancel() property which can be used to notify any traceed interactions that the async work has been cancelled.


Tracing initial render

import { unstable_trace as trace } from "scheduler/tracing";

trace("initial render",, () => render(<Application />));

Tracing state updates

import { unstable_trace as trace } from "scheduler/tracing";

class MyComponent extends Component {
  handleLoginButtonClick = event => {
    trace("Login button click",, () => {
      this.setState({ isLoggingIn: true });

  // render ...

Tracing async work

import {
  unstable_trace as trace,
  unstable_wrap as wrap
} from "scheduler/tracing";

trace("Some event",, () => {
    wrap(() => {
      // Do some async work
Copy link

I'm seeing "No interactions were recorded" in the devtools when I try and use this :(

Any thoughts?

"react": "^16.8.6"
"scheduler": "^0.20.1",

Copy link

shackra commented Dec 3, 2020

I"m on the same boat with no interactions were recorded

  • "scheduler": "^0.20.1",
  • "react": "^17.0.1",
  • "react-context-devtool": "^2.0.0",

Copy link

Same here

Copy link

jviall commented Feb 11, 2021

no interactions were recorded with

  • scheduler: 0.19.1 (also tried 0.20.1 but noticed react-dom used 0.19.1)
  • react: 16.14.0
  • react-dom: 16.14.0
  • React Dev Tools: 4.10.1

Copy link

MitchelSt commented Mar 27, 2021

How would I go over using async (wrap) using a async/await try-catch?

  const onClick = () => {
    trace('clicked "fetch" button',, async () => {
      try {
        const { data } = await axios(
      } catch (error) {

Copy link

Interactions option in Devtools does not exist. Tracing interactions does not work too -> schedule 0.4.0.

Copy link

leviathan264 commented Jan 10, 2024

Anyone know the status of this or what the current recommend practice is? Any sort of unstable_trace or <Profiler/> stats are not showing up for me in the Profiler tab in latest version of React Developer Tools.

    "react-dom": "17.0.2",
    "scheduler": "0.20.2"

Copy link

This feature has been removed from React and the DevTools. I've not seen anything to suggest they'll return.

Copy link

bvaughn commented Jan 10, 2024

This header text is the very top of the page.
Screenshot 2024-01-10 at 3 22 44 PM

Copy link

Since the API has been removed, is there any other way to achieve this currently? We are using React 18, and we want to track the total re-rendering time resulting from a particular interaction. In our case, the component gets re-rendered multiple times, leading to significant jank, but the profiler numbers are less compared to the actual jank experienced.

So, the total re-rendering time (including all re-renders) after one interaction is 500ms, but the profiler data shows individual re-render times, which are not as relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment