com.qeagle.devtools.protocol.commands

Interface Tracing

public interface Tracing

Method Summary

Modifier and Type	Method and Description
void	end() Stop trace events collection.
List<String>	getCategories() Gets supported tracing categories.
EventListener	onBufferUsage(EventHandler<BufferUsage> eventListener)
EventListener	onDataCollected(EventHandler<DataCollected> eventListener) Contains an bucket of collected trace events.
EventListener	onTracingComplete(EventHandler<TracingComplete> eventListener) Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.
void	recordClockSyncMarker(String syncId) Record a clock sync marker in the trace.
RequestMemoryDump	requestMemoryDump() Request a global memory dump.
void	start() Start trace events collection.
void	start(String categories, String options, Double bufferUsageReportingInterval, StartTransferMode transferMode, StreamFormat streamFormat, StreamCompression streamCompression, TraceConfig traceConfig) Start trace events collection.

Method Detail

end

void end()

Stop trace events collection.

getCategories

List<String> getCategories()

Gets supported tracing categories.

recordClockSyncMarker

void recordClockSyncMarker(String syncId)

Record a clock sync marker in the trace.

Parameters:

syncId - The ID of this clock sync marker

requestMemoryDump

RequestMemoryDump requestMemoryDump()

Request a global memory dump.

start

void start()

Start trace events collection.

start

void start(@Deprecated
           String categories,
           @Deprecated
           String options,
           Double bufferUsageReportingInterval,
           StartTransferMode transferMode,
           StreamFormat streamFormat,
           StreamCompression streamCompression,
           TraceConfig traceConfig)

Start trace events collection.

Parameters:

categories - Category/tag filter

options - Tracing options

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

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

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

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

traceConfig -

onBufferUsage

EventListener onBufferUsage(EventHandler<BufferUsage> eventListener)

onDataCollected

EventListener onDataCollected(EventHandler<DataCollected> eventListener)

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.

onTracingComplete

EventListener onTracingComplete(EventHandler<TracingComplete> eventListener)

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