Tracing Domain
Methods
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.
end#
Stop trace events collection.
getCategories#
Gets supported tracing categories.
Return object
- categories
- array [string] A list of supported tracing categories.
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.
Events
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]
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.
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.