PerfettoTraceProcessor


@ExperimentalPerfettoTraceProcessorApi
class PerfettoTraceProcessor


Kotlin API for Perfetto Trace Processor, which enables SQL querying against the data stored in a Perfetto trace.

This includes synchronous and async trace sections, kernel-level scheduling timing, binder events... If it's displayed in Android Studio system trace or ui.perfetto.dev, it can be queried from this API.

// Collect the duration of all slices named "activityStart" in the trace
val activityStartDurationNs = PerfettoTraceProcessor.runServer {
loadTrace(trace) {
query("SELECT dur FROM slice WHERE name LIKE \"activityStart\"").toList {
it.long("dur")
}
}
}

Note that traces generally hold events from multiple apps, services and processes, so it's recommended to filter potentially common trace events to the process you're interested in. See the following example which queries Choreographer#doFrame slices (labelled spans of time) only for a given package name:

query("""
|SELECT
| slice.name,slice.ts,slice.dur
|FROM slice
| INNER JOIN thread_track on slice.track_id = thread_track.id
| INNER JOIN thread USING(utid)
| INNER JOIN process USING(upid)
|WHERE
| slice.name LIKE "Choreographer#doFrame%" AND
| process.name LIKE "$packageName"
""".trimMargin()
)

See also Perfetto project documentation:

See also
PerfettoTrace

Summary

Nested types

Handle to query sql data from a PerfettoTrace.

Public companion functions

T
<T : Any?> runServer(block: PerfettoTraceProcessor.() -> T)

Starts a Perfetto trace processor shell server in http mode, loads a trace and executes the given block.

T
<T : Any?> runServer(timeout: Duration, block: PerfettoTraceProcessor.() -> T)

Starts a Perfetto trace processor shell server in http mode, loads a trace and executes the given block.

Public constructors

Public functions

T
<T : Any?> loadTrace(trace: PerfettoTrace, block: PerfettoTraceProcessor.Session.() -> T)

Loads a PerfettoTrace into the trace processor server to query data out of the trace.

Public companion functions

runServer

Added in 1.2.0
fun <T : Any?> runServer(block: PerfettoTraceProcessor.() -> T): T

Starts a Perfetto trace processor shell server in http mode, loads a trace and executes the given block. It stops the server after the block is complete

Uses a default timeout of 5 seconds

Parameters
block: PerfettoTraceProcessor.() -> T

Command to execute using trace processor

runServer

fun <T : Any?> runServer(timeout: Duration, block: PerfettoTraceProcessor.() -> T): T

Starts a Perfetto trace processor shell server in http mode, loads a trace and executes the given block. It stops the server after the block is complete

Parameters
timeout: Duration

waiting for the server to start. If less or equal to zero use 5 seconds

block: PerfettoTraceProcessor.() -> T

Command to execute using trace processor

Public constructors

PerfettoTraceProcessor

Added in 1.2.0
PerfettoTraceProcessor()

Public functions

loadTrace

Added in 1.2.0
fun <T : Any?> loadTrace(trace: PerfettoTrace, block: PerfettoTraceProcessor.Session.() -> T): T

Loads a PerfettoTrace into the trace processor server to query data out of the trace.