Chrome DevTools Protocol

Methods

Tracing.end

Stop trace events collection.

Tracing.getCategories

Gets supported tracing categories.

Return Object
categories
array[ string ]

A list of supported tracing categories.

Tracing.recordClockSyncMarker

Record a clock sync marker in the trace.

parameters
syncId
string

The ID of this clock sync marker

Tracing.requestMemoryDump

Request a global memory dump.

parameters
deterministic
boolean

Enables more deterministic results by forcing garbage collection

levelOfDetail
MemoryDumpLevelOfDetail

Specifies level of details in memory dump. Defaults to "detailed".

Return Object
dumpGuid
string

GUID of the resulting global memory dump.

success
boolean

True iff the global memory dump succeeded.

Tracing.start

Start trace events collection.

parameters
categories
string

Category/tag filter

Deprecated
options
string

Tracing options

Deprecated
bufferUsageReportingInterval
number

If set, the agent will issue bufferUsage events at this interval, specified in milliseconds

transferMode
string

Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents).

Allowed Values: ReportEvents, ReturnAsStream
streamFormat
StreamFormat

Trace data format to use. This only applies when using ReturnAsStream transfer mode (defaults to json).

streamCompression
StreamCompression

Compression format to use. This only applies when using ReturnAsStream transfer mode (defaults to none)

traceConfig
TraceConfig
perfettoConfig
string

Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters categories, options, traceConfig are ignored. (Encoded as a base64 string when passed over JSON)

tracingBackend
TracingBackend

Backend type (defaults to auto)

Events

Tracing.bufferUsage

parameters
percentFull
number

A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.

eventCount
number

An approximate number of events in the trace log.

value
number

A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.

Tracing.dataCollected

Contains an bucket of collected trace events. When tracing is stopped collected events will be send as a sequence of dataCollected events followed by tracingComplete event.

parameters
value
array[ object ]

Tracing.tracingComplete

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

parameters
dataLossOccurred
boolean

Indicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around.

stream
IO.StreamHandle

A handle of the stream that holds resulting trace data.

traceFormat
StreamFormat

Trace data format of returned stream.

streamCompression
StreamCompression

Compression format of returned stream.

Types

Tracing.MemoryDumpConfig

Configuration for memory dump. Used only when "memory-infra" category is enabled.

Type: object

Tracing.MemoryDumpLevelOfDetail

Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

Allowed Values: background, light, detailed

Type: string

Tracing.StreamCompression

Compression type to use for traces returned via streams.

Allowed Values: none, gzip

Type: string

Tracing.StreamFormat

Data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.

Allowed Values: json, proto

Type: string

Tracing.TraceConfig

Type: object

properties
recordMode
string

Controls how the trace buffer stores data.

Allowed Values: recordUntilFull, recordContinuously, recordAsMuchAsPossible, echoToConsole
enableSampling
boolean

Turns on JavaScript stack sampling.

enableSystrace
boolean

Turns on system tracing.

enableArgumentFilter
boolean

Turns on argument filter.

includedCategories
array[ string ]

Included category filters.

excludedCategories
array[ string ]

Excluded category filters.

syntheticDelays
array[ string ]

Configuration to synthesize the delays in tracing.

memoryDumpConfig
MemoryDumpConfig

Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.

Tracing.TracingBackend

Backend type to use for tracing. chrome uses the Chrome-integrated tracing service and is supported on all platforms. system is only supported on Chrome OS and uses the Perfetto system tracing service. auto chooses system when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses chrome.

Allowed Values: auto, chrome, system

Type: string