Register now for Android Dev Summit 2019!

TraceCompat

class TraceCompat
kotlin.Any
   ↳ androidx.core.os.TraceCompat

Writes trace events to the system trace buffer. These trace events can be collected and visualized using the Systrace tool.

This tracing mechanism is independent of the method tracing mechanism offered by android.os.Debug#startMethodTracing. In particular, it enables tracing of events that occur across multiple processes.

For information about using the Systrace tool, read Analyzing Display and Performance with Systrace.

Summary

Public methods

static Unit
beginSection(@NonNull sectionName: String)

Writes a trace message to indicate that a given section of code has begun.

static Unit

Writes a trace message to indicate that a given section of code has ended.

Public methods

beginSection

static fun beginSection(@NonNull sectionName: String): Unit

Writes a trace message to indicate that a given section of code has begun. This call must be followed by a corresponding call to endSection() on the same thread.

At this time the vertical bar character '|', newline character '\n', and null character '\0' are used internally by the tracing mechanism. If sectionName contains these characters they will be replaced with a space character in the trace.

Parameters
sectionName String: The name of the code section to appear in the trace. This may be at most 127 Unicode code units long.

endSection

static fun endSection(): Unit

Writes a trace message to indicate that a given section of code has ended. This call must be preceeded by a corresponding call to beginSection(String). Calling this method will mark the end of the most recently begun section of code, so care must be taken to ensure that beginSection / endSection pairs are properly nested and called from the same thread.