timeline.md

Table of Contents

• Timeline
  • isRecording
  • start
  • stop

Timeline

Extends Actor

The timeline actor pops and forwards timeline markers registered in docshells.

isRecording

Are we recording profile markers currently?

Returns Promise.Boolean true if actor is profiling

start

Start recording profile markers.

Parameters

• withMarkers Boolean Boolean indicating whether or not timeline markers are emitted once they're accumulated every DEFAULT_TIMELINE_DATA_PULL_TIMEOUT milliseconds.
• withTicks Boolean Boolean indicating whether a ticks event is fired and a FramerateActor is created.
• withMemory Boolean Boolean indiciating whether we want memory measurements sampled.
• withFrames Boolean Boolean indicating whether or not stack frames should be handled from timeline markers.
• withGCEvents Boolean Boolean indicating whether or not GC markers should be emitted. TODO: Remove these fake GC markers altogether in bug 1198127.
• withDocLoadingEvents Boolean Boolean indicating whether or not DOMContentLoaded and Load marker events are emitted.

Returns Promise.Number start time of recording

stop

Stop recording profile markers.

Returns Promise.Number end time of recording