cdp/dev.kdriver.cdp.domain/Tracing

Tracing

Constructors

constructor(cdp: CDP)

Types

@Serializable

data class BufferUsageParameter(val percentFull: Double? = null, val eventCount: Double? = null, val value: Double? = null)

DataCollectedParameter

@Serializable

data class DataCollectedParameter(val value: List<Map<String, JsonElement>>)

Contains a bucket of collected trace events. When tracing is stopped collected events will be sent as a sequence of dataCollected events followed by tracingComplete event.

GetCategoriesReturn

@Serializable

data class GetCategoriesReturn(val categories: List<String>)

MemoryDumpLevelOfDetail

@Serializable

enum MemoryDumpLevelOfDetail : Enum<Tracing.MemoryDumpLevelOfDetail>

Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

RecordClockSyncMarkerParameter

@Serializable

data class RecordClockSyncMarkerParameter(val syncId: String)

RequestMemoryDumpParameter

@Serializable

data class RequestMemoryDumpParameter(val deterministic: Boolean? = null, val levelOfDetail: Tracing.MemoryDumpLevelOfDetail? = null)

RequestMemoryDumpReturn

@Serializable

data class RequestMemoryDumpReturn(val dumpGuid: String, val success: Boolean)

StartParameter

@Serializable

data class StartParameter(val categories: String? = null, val options: String? = null, val bufferUsageReportingInterval: Double? = null, val transferMode: String? = null, val streamFormat: Tracing.StreamFormat? = null, val streamCompression: Tracing.StreamCompression? = null, val traceConfig: Tracing.TraceConfig? = null, val perfettoConfig: String? = null, val tracingBackend: Tracing.TracingBackend? = null)

StreamCompression

@Serializable

enum StreamCompression : Enum<Tracing.StreamCompression>

Compression type to use for traces returned via streams.

StreamFormat

@Serializable

enum StreamFormat : Enum<Tracing.StreamFormat>

Data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.

TraceConfig

@Serializable

data class TraceConfig(val recordMode: String? = null, val traceBufferSizeInKb: Double? = null, val enableSampling: Boolean? = null, val enableSystrace: Boolean? = null, val enableArgumentFilter: Boolean? = null, val includedCategories: List<String>? = null, val excludedCategories: List<String>? = null, val syntheticDelays: List<String>? = null, val memoryDumpConfig: Map<String, JsonElement>? = null)

TracingBackend

@Serializable

enum TracingBackend : Enum<Tracing.TracingBackend>

Backend type to use for tracing. chrome uses the Chrome-integrated tracing service and is supported on all platforms. system is only supported on Chrome OS and uses the Perfetto system tracing service. auto chooses system when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses chrome.

TracingCompleteParameter

@Serializable

data class TracingCompleteParameter(val dataLossOccurred: Boolean, val stream: String? = null, val traceFormat: Tracing.StreamFormat? = null, val streamCompression: Tracing.StreamCompression? = null)

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

Properties

bufferUsage

val bufferUsage: Flow<Tracing.BufferUsageParameter>

dataCollected

val dataCollected: Flow<Tracing.DataCollectedParameter>

Contains a bucket of collected trace events. When tracing is stopped collected events will be sent as a sequence of dataCollected events followed by tracingComplete event.

tracingComplete

val tracingComplete: Flow<Tracing.TracingCompleteParameter>

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

Functions

end

suspend fun end(mode: CommandMode = CommandMode.DEFAULT)

Stop trace events collection.

getCategories

suspend fun getCategories(mode: CommandMode = CommandMode.DEFAULT): Tracing.GetCategoriesReturn

Gets supported tracing categories.

recordClockSyncMarker

suspend fun recordClockSyncMarker(syncId: String)

suspend fun recordClockSyncMarker(args: Tracing.RecordClockSyncMarkerParameter, mode: CommandMode = CommandMode.DEFAULT)

Record a clock sync marker in the trace.

requestMemoryDump

suspend fun requestMemoryDump(args: Tracing.RequestMemoryDumpParameter, mode: CommandMode = CommandMode.DEFAULT): Tracing.RequestMemoryDumpReturn

suspend fun requestMemoryDump(deterministic: Boolean? = null, levelOfDetail: Tracing.MemoryDumpLevelOfDetail? = null): Tracing.RequestMemoryDumpReturn

Request a global memory dump.

start

suspend fun start(args: Tracing.StartParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun start(categories: String? = null, options: String? = null, bufferUsageReportingInterval: Double? = null, transferMode: String? = null, streamFormat: Tracing.StreamFormat? = null, streamCompression: Tracing.StreamCompression? = null, traceConfig: Tracing.TraceConfig? = null, perfettoConfig: String? = null, tracingBackend: Tracing.TracingBackend? = null)

Start trace events collection.