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
beginAsyncSection(@NonNull methodName: String, cookie: Int)

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

static Unit
beginSection(@NonNull sectionName: String)

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

static Unit
endAsyncSection(@NonNull methodName: String, cookie: Int)

Writes a trace message to indicate that the current method has ended.

static Unit

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

static Boolean

Checks whether or not tracing is currently enabled.

static Unit
setCounter(@NonNull counterName: String, counterValue: Int)

Writes trace message to indicate the value of a given counter.

Public methods

beginAsyncSection

static fun beginAsyncSection(@NonNull methodName: String, cookie: Int): Unit

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endAsyncSection(String, int) with the same methodName and cookie. Unlike beginSection(String) and endSection(), asynchronous events do not need to be nested. The name and cookie used to begin an event must be used to end it.

Parameters
methodName String: The method name to appear in the trace.
cookie String: Unique identifier for distinguishing simultaneous events

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.

endAsyncSection

static fun endAsyncSection(@NonNull methodName: String, cookie: Int): Unit

Writes a trace message to indicate that the current method has ended. Must be called exactly once for each call to beginAsyncSection(String, int) using the same name and cookie.

Parameters
methodName String: The method name to appear in the trace.
cookie String: Unique identifier for distinguishing simultaneous events

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.

isEnabled

static fun isEnabled(): Boolean

Checks whether or not tracing is currently enabled. This is useful to avoid intermediate string creation for trace sections that require formatting. It is not necessary to guard all Trace method calls as they internally already check this. However it is recommended to use this to prevent creating any temporary objects that would then be passed to those methods to reduce runtime cost when tracing isn't enabled.

Return
Boolean: true if tracing is currently enabled, false otherwise

setCounter

static fun setCounter(@NonNull counterName: String, counterValue: Int): Unit

Writes trace message to indicate the value of a given counter.

Parameters
counterName String: The counter name to appear in the trace.
counterValue String: The counter value.