androidx.tracing.wire

---

Kotlin |Java

Common/AllAndroid/JVM

Classes

InMemoryRingBufferTraceSink	A AbstractTraceSink that stores TraceEvents in a fixed-size ring buffer to minimize allocations.	Cmn
TraceDriver	The entry point to tracing APIs.	Cmn android
TraceSink	The trace sink that writes BufferedSink, to a new file per trace session.	Cmn

Annotations

ExperimentalRingBufferApi

Marks declarations in the Tracing API that are highly experimental for ring buffer tracing.

Cmn

Top-level functions summary

TraceSink	TraceSink(     directory: File,     sequenceId: Int,     coroutineContext: CoroutineContext )	android
TraceSink	TraceSink(     context: Context,     sequenceId: Int,     coroutineContext: CoroutineContext,     outputStream: OutputStream )	android
TraceSink	TraceSink(     context: Context,     sequenceId: Int,     coroutineContext: CoroutineContext,     traceFile: File )	android

Extension functions summary

File

File.createPerfettoFile(prefix: String) Creates a File that can be used to store in-process trace events.

android

Top-level functions

TraceSink

android

Artifact: androidx.tracing:tracing-wire

View Source

fun TraceSink(
    directory: File,
    sequenceId: Int,
    coroutineContext: CoroutineContext = Dispatchers.IO
): TraceSink

TraceSink

android

Artifact: androidx.tracing:tracing-wire

View Source

Added in 2.0.0-alpha07

fun TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    outputStream: OutputStream
): TraceSink

TraceSink

android

Artifact: androidx.tracing:tracing-wire

View Source

Added in 2.0.0-alpha07

fun TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    traceFile: File = context.filesDir.createPerfettoFile()
): TraceSink

Extension functions

File.createPerfettoFile

android

Artifact: androidx.tracing:tracing-wire

View Source

Added in 2.0.0-alpha07

fun File.createPerfettoFile(prefix: String = PREFIX): File

Creates a File that can be used to store in-process trace events.

Parameters
File	The parent directory used to store the trace file. // On the JVM File parent = File("/tmp/traces") File trace = parent.createPerfettoFile() // On Android File parent = context.cacheDir File trace = parent.createPerfettoFile()
prefix: String = PREFIX	The file name prefix for the trace file. The default value is perfetto.

Returns
File	the trace File, for a given parent directory, that can be used by the androidx.tracing.AbstractTraceSink.