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.

import androidx.benchmark.macro.runServer
import androidx.benchmark.traceprocessor.PerfettoTrace
import androidx.benchmark.traceprocessor.TraceProcessor

// Collect the duration of all slices named "activityStart" in the trace
val activityStartDurNs =
    TraceProcessor.runServer {
        loadTrace(PerfettoTrace("/path/to/trace.perfetto-trace")) {
                query("SELECT dur FROM slice WHERE name = 'activityStart'").map {
                    it.long("dur")
                }
            }
            .toList()
    }
return activityStartDurNs

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:

import androidx.benchmark.traceprocessor.PerfettoTrace

loadTrace(PerfettoTrace("/path/to/trace.perfetto-trace")) {
    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 = "$packageName"
        """
                .trimMargin()
        )
        .forEach {
            // process each observed doFrame slice
            doFrameCallback(it.string("name"), it.long("ts"), it.long("dur"))
        }
}

See also Perfetto project documentation:

See also
PerfettoTrace

Summary

Nested types

Handle to query sql data from a PerfettoTrace.

Public companion functions
T
@ExperimentalTraceProcessorApi
@<Error class: unknown class>
<T : Any?> runServer(
    serverLifecycleManager: ServerLifecycleManager,
    eventCallback: TraceProcessor.EventCallback,
    tracer: TraceProcessor.Tracer,
    timeout: Duration,
    block: TraceProcessor.() -> T
)

Starts a Perfetto trace processor shell server in http mode, loads a trace and executes the given block.
Cmn
TraceProcessor.Handle
@ExperimentalTraceProcessorApi
@<Error class: unknown class>
startServer(
    serverLifecycleManager: ServerLifecycleManager,
    eventCallback: TraceProcessor.EventCallback,
    tracer: TraceProcessor.Tracer,
    timeout: Duration
)

Starts a Perfetto trace processor shell server in http mode, and returns a Handle which can be used to access and close the TraceProcessor server instance.
Cmn

Public constructors
Cmn

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

Loads a PerfettoTrace into the trace processor server to query data out of the trace.
Cmn
TraceProcessor.Session.Handle

Loads a PerfettoTrace into the TraceProcessor server, and returns a Session.Handle which can be used to access and close a Session.
Cmn

Public companion functions

runServer

Cmn 
@ExperimentalTraceProcessorApi
@<Error class: unknown class>
fun <T : Any?> runServer(
    serverLifecycleManager: ServerLifecycleManager,
    eventCallback: TraceProcessor.EventCallback,
    tracer: TraceProcessor.Tracer,
    timeout: Duration = DEFAULT_TIMEOUT,
    block: TraceProcessor.() -> T
): T

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

import androidx.benchmark.macro.runServer
import androidx.benchmark.traceprocessor.PerfettoTrace
import androidx.benchmark.traceprocessor.TraceProcessor

// Collect the duration of all slices named "activityStart" in the trace
val activityStartDurNs =
    TraceProcessor.runServer {
        loadTrace(PerfettoTrace("/path/to/trace.perfetto-trace")) {
                query("SELECT dur FROM slice WHERE name = 'activityStart'").map {
                    it.long("dur")
                }
            }
            .toList()
    }
return activityStartDurNs
Parameters
serverLifecycleManager: ServerLifecycleManager

controls starting and stopping the TraceProcessor process.
eventCallback: TraceProcessor.EventCallback

callback for events such as trace load failure.
tracer: TraceProcessor.Tracer

used to trace begin and end of significant events within this managed run.
timeout: Duration = DEFAULT_TIMEOUT

maximum duration for waiting for operations like loading the server, or querying a trace.
block: TraceProcessor.() -> T

Command to execute using trace processor

startServer

Cmn 
@ExperimentalTraceProcessorApi
@<Error class: unknown class>
fun startServer(
    serverLifecycleManager: ServerLifecycleManager,
    eventCallback: TraceProcessor.EventCallback,
    tracer: TraceProcessor.Tracer,
    timeout: Duration = DEFAULT_TIMEOUT
): TraceProcessor.Handle

Starts a Perfetto trace processor shell server in http mode, and returns a Handle which can be used to access and close the TraceProcessor server instance.

import androidx.benchmark.macro.startServer
import androidx.benchmark.traceprocessor.PerfettoTrace
import androidx.benchmark.traceprocessor.TraceProcessor

// Collect the duration of all slices named "activityStart" in the trace
val activityStartDurNs =
    TraceProcessor.startServer().use {
        it.traceProcessor.startSession(PerfettoTrace("/path/to/trace.perfetto-trace")).use {
            it.session
                .query("SELECT dur FROM slice WHERE name = 'activityStart'")
                .map { it.long("dur") }
                .toList()
        }
    }
return activityStartDurNs
Parameters
serverLifecycleManager: ServerLifecycleManager

controls starting and stopping the TraceProcessor process.
eventCallback: TraceProcessor.EventCallback

callback for events such as trace load failure.
tracer: TraceProcessor.Tracer

used to trace begin and end of significant events within this managed run.
timeout: Duration = DEFAULT_TIMEOUT

maximum duration for waiting for operations like loading the server, or querying a trace.

Public constructors

TraceProcessor

Cmn 
@<Error class: unknown class>
@ExperimentalTraceProcessorApi
TraceProcessor(
    serverLifecycleManager: ServerLifecycleManager,
    tracer: TraceProcessor.Tracer = Tracer(),
    eventCallback: TraceProcessor.EventCallback = EventCallback.Noop,
    timeout: Duration = DEFAULT_TIMEOUT
)

Public functions

loadTrace

Cmn
Added in 1.4.0-alpha10
fun <T : Any?> loadTrace(trace: PerfettoTrace, block: TraceProcessor.Session.() -> T): T

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

startSession

Cmn
Added in 1.4.0-alpha10
fun startSession(trace: PerfettoTrace): TraceProcessor.Session.Handle

Loads a PerfettoTrace into the TraceProcessor server, and returns a Session.Handle which can be used to access and close a Session.