Tracing Domain
Methods
Events
Types
Methods
Tracing.end #
Stop trace events collection.
Tracing.start #
Start trace events collection.
parameters
- categories
-
string
Category/tag filter
- options
-
string
Tracing options
- 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 tojson
). - streamCompression
-
StreamCompression
Compression format to use. This only applies when using
ReturnAsStream
transfer mode (defaults tonone
) - 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.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.TraceConfig #
Type: object
properties
- recordMode
-
string
Controls how the trace buffer stores data.
Allowed Values:recordUntilFull
,recordContinuously
,recordAsMuchAsPossible
,echoToConsole
- traceBufferSizeInKb
-
number
Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used.
- 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.