Tracing Domain
Methods
Tracing.start #
Start trace events collection.
Tracing.start is implemented as a stub only.
Parameters
categoriesOptional
stringCategory/tag filter
optionsOptional
stringTracing options
bufferUsageReportingIntervalOptional
numberIf set, the agent will issue bufferUsage events at this interval, specified in milliseconds
transferModeOptional
stringWhether to report trace events as series of dataCollected events or to save trace to a
stream (defaults to ReportEvents).
Allowed values: ReportEvents, ReturnAsStream
streamFormatOptional
Trace data format to use. This only applies when using ReturnAsStream
transfer mode (defaults to json).
streamCompressionOptional
Compression format to use. This only applies when using ReturnAsStream
transfer mode (defaults to none)
traceConfigOptional
perfettoConfigOptional
stringBase64-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)
tracingBackendOptional
Events
Tracing.tracingComplete #
Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.
Tracing.tracingComplete is implemented as a stub only.
Parameters
dataLossOccurred booleanIndicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around.
streamOptional
A handle of the stream that holds resulting trace data.
traceFormatOptional
Trace data format of returned stream.
streamCompressionOptional
Compression format of returned stream.
Types
Tracing.TraceConfig #
Type: object
Properties
recordModeOptional
stringControls how the trace buffer stores data.
Allowed values: recordUntilFull, recordContinuously, recordAsMuchAsPossible, echoToConsole
traceBufferSizeInKbOptional
numberSize of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used.
enableSamplingOptional
booleanTurns on JavaScript stack sampling.
enableSystraceOptional
booleanTurns on system tracing.
enableArgumentFilterOptional
booleanTurns on argument filter.
includedCategoriesOptional
array[ string ]Included category filters.
excludedCategoriesOptional
array[ string ]Excluded category filters.
syntheticDelaysOptional
array[ string ]Configuration to synthesize the delays in tracing.
memoryDumpConfigOptional
Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.