Tracing Domain
Experimental
Methods
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. - traceConfig
- TraceConfig
Tracing.end #
Stop trace events collection.
Tracing.getCategories #
Gets supported tracing categories.
Return object
- categories
- array [string] A list of supported tracing categories.
Tracing.requestMemoryDump #
Request a global memory dump.
Return object
- dumpGuid
- string GUID of the resulting global memory dump.
- success
- boolean True iff the global memory dump succeeded.
Tracing.recordClockSyncMarker #
Record a clock sync marker in the trace.
Parameters
- syncId
- string The ID of this clock sync marker
Events
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
- stream
- IO.StreamHandle A handle of the stream that holds resulting trace data.
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.
Types
MemoryDumpConfig#
Configuration for memory dump. Used only when "memory-infra" category is enabled.
Type: object
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.