EventMetadata

Makes it possible to associate debug metadata & categories to a TraceEvent. Typically obtained by a call to Tracer.beginSectionWithMetadata.

Summary

Public functions
abstract Unit
addCallStackEntry(name: String, sourceFile: String?, lineNumber: Int)

Adds call stack frame information to the TraceEvent.
android
abstract Unit

Adds additional categories to the TraceEvent.
android
abstract Unit

Add a Long correlation id to the trace packet.
android
abstract Unit

Adds a String correlation id to the trace packet.
android
abstract Unit
addMetadataEntry(name: String, value: Boolean)

Adds a metadata entry where the type of the value is an Boolean.
android
abstract Unit
addMetadataEntry(name: String, value: Double)

Adds a metadata entry where the type of the value is an Double.
android
abstract Unit
addMetadataEntry(name: String, value: Long)

Adds a metadata entry where the type of the value is an Long.
android
abstract Unit
addMetadataEntry(name: String, value: String)

Adds a metadata entry where the type of the value is an String.
android
abstract Unit

Dispatches the underlying TraceEvent to the AbstractTraceSink instance if applicable.
android

Public functions

addCallStackEntry

android
Added in 2.0.0-rc01
abstract fun addCallStackEntry(name: String, sourceFile: String?, lineNumber: Int): Unit

Adds call stack frame information to the TraceEvent.

addCategory

android
Added in 2.0.0-rc01
abstract fun addCategory(name: String): Unit

Adds additional categories to the TraceEvent.

This is useful when an application is interested in a subset of TraceEvents that belong to well known categories. These are typically small identifiers useful for namespacing TraceEvents.

addCorrelationId

android
Added in 2.0.0-rc01
abstract fun addCorrelationId(id: Long): Unit

Add a Long correlation id to the trace packet.

addCorrelationId

android
Added in 2.0.0-rc01
abstract fun addCorrelationId(id: String): Unit

Adds a String correlation id to the trace packet.

Consider using the addCorrelationId(Long) variant for performance reasons when possible.

addMetadataEntry

android
Added in 2.0.0-rc01
abstract fun addMetadataEntry(name: String, value: Boolean): Unit

Adds a metadata entry where the type of the value is an Boolean.

addMetadataEntry

android
Added in 2.0.0-rc01
abstract fun addMetadataEntry(name: String, value: Double): Unit

Adds a metadata entry where the type of the value is an Double.

addMetadataEntry

android
Added in 2.0.0-rc01
abstract fun addMetadataEntry(name: String, value: Long): Unit

Adds a metadata entry where the type of the value is an Long.

addMetadataEntry

android
Added in 2.0.0-rc01
abstract fun addMetadataEntry(name: String, value: String): Unit

Adds a metadata entry where the type of the value is an String.

dispatchToTraceSink

android
Added in 2.0.0-rc01
@DelicateTracingApi
abstract fun dispatchToTraceSink(): Unit

Dispatches the underlying TraceEvent to the AbstractTraceSink instance if applicable.