chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.tracing

Package-level declarations

Types

@Serializable

A dummy response object for the TracingDomain.end command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

GetCategoriesResponse

@Serializable

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

Response type for the TracingDomain.getCategories command.

MemoryDumpConfig

typealias MemoryDumpConfig = JsonObject

Configuration for memory dump. Used only when "memory-infra" category is enabled.

Official doc

MemoryDumpLevelOfDetail

@Serializable

enum MemoryDumpLevelOfDetail : Enum<MemoryDumpLevelOfDetail>

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

RecordClockSyncMarkerRequest

@Serializable

data class RecordClockSyncMarkerRequest(val syncId: String)

Request object containing input parameters for the TracingDomain.recordClockSyncMarker command.

RecordClockSyncMarkerResponse

@Serializable

object RecordClockSyncMarkerResponse

A dummy response object for the TracingDomain.recordClockSyncMarker command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RequestMemoryDumpRequest

@Serializable

data class RequestMemoryDumpRequest(val deterministic: Boolean? = null, val levelOfDetail: MemoryDumpLevelOfDetail? = null)

Request object containing input parameters for the TracingDomain.requestMemoryDump command.

RequestMemoryDumpResponse

@Serializable

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

Response type for the TracingDomain.requestMemoryDump command.

StartRequest

@Serializable

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

Request object containing input parameters for the TracingDomain.start command.

StartResponse

@Serializable

object StartResponse

A dummy response object for the TracingDomain.start command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StreamCompression

@Serializable

enum StreamCompression : Enum<StreamCompression>

Compression type to use for traces returned via streams.

StreamFormat

@Serializable

enum StreamFormat : Enum<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: TraceConfigRecordMode? = 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: MemoryDumpConfig? = null)

Official doc

TraceConfigRecordMode

@Serializable

enum TraceConfigRecordMode : Enum<TraceConfigRecordMode>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

TracingBackend

@Serializable

enum TracingBackend : Enum<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.

TracingDomain

class TracingDomain

Official doc

TransferMode

@Serializable

enum TransferMode : Enum<TransferMode>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used: