1.0: Timeline

Contents

  1. Commands
    1. start
    2. stop
  2. Notifications
    1. eventRecorded
  3. Types
    1. TimelineEvent

Timeline provides its clients with instrumentation records that are generated during the page runtime. Timeline instrumentation can be started and stopped using corresponding commands. While timeline is started, it is generating timeline event records.

Commands

Timeline.start

request: {
"id": <number>,
"method": "Timeline.start",
"params": {
  "maxCallStackDepth": <integer>
}
}
response: {
"id": <number>,
"error": <object>
}

Starts capturing instrumentation events.

Parameters

maxCallStackDepth
( optional integer )
Samples JavaScript stack traces up to maxCallStackDepth, defaults to 5.

Timeline.stop

request: {
"id": <number>,
"method": "Timeline.stop"
}
response: {
"id": <number>,
"error": <object>
}

Stops capturing instrumentation events.

Notifications

Timeline.eventRecorded

{
"method": "Timeline.eventRecorded",
"params": {
  "record": <TimelineEvent>
}
}

Fired for every instrumentation event while timeline is started.

Parameters

record
Timeline event record data.

Types

TimelineEvent: object

children
( optional array of TimelineEvent )
Nested records.
data
( object )
Event data.
type
( string )
Event type.