TraceEvent

Artifact: androidx.tracing:tracing

View Source

Added in 2.0.0-rc01

---

Kotlin |Java

Android/JVM

• android

  @DelicateTracingApi
  class TraceEvent

---

Mutable in-memory only representation a trace event, such as a slice start, slice end, or counter update.

This structure is optimized for performance, with the expectation that these are created by a trace event, and passed to a background thread to be serialized. Mutability (and thus reuse) is an important component of this.

Code outside of tracing-driver implementation should only ever consume these objects, not produce them.

Summary

Public constructors
TraceEvent()	android

Public functions
Unit	copyFrom(src: TraceEvent)	android
Unit	reset()	android

Public properties
MutableList<AttributeEntry>	attributes The list of trace attributes associated with the trace.	android
MutableList<String>	categories The categories that this Trace Event belongs to.	android
Long?	correlationId The optional correlation id associated with the event.	android
String?	correlationIdString The optional correlation id as String that is associated with the event.	android
Double?	counterDoubleValue Value of the trace event if the event type is TRACE_EVENT_TYPE_COUNTER.	android
Long?	counterLongValue Value of the trace event if the event type is TRACE_EVENT_TYPE_COUNTER.	android
List<Long>	flowIds List of trace flows associated with this event.	android
MutableList<Frame>	frames A list of call stack frames that can be associated to the androidx.tracing.TraceEvent.	android
Int	lastAttributeIndex Keeping track of the index separately for attributes, because the MutableList is pre-allocated with sentinel objects for performance reasons.	android
Int	lastCategoryIndex Keeping track of the index separately for categories, because the MutableList is pre-allocated with sentinel objects for performance reasons.	android
Int	lastFrameIndex Keeping track of the index separately for frames, because the MutableList is pre-allocated with sentinel objects for performance reasons.	android
Int	lastMetadataEntryIndex Keeping track of the index separately, because the MutableList is pre-allocated with sentinel objects for performance reasons.	android
MutableList<MetadataEntry>	metadataEntries The list of debug annotations associated with a slice	android
String?	name Name of the trace event - null if the event type is TRACE_EVENT_TYPE_COUNTER.	android
String	primaryCategory The primary category that this trace event belongs to.	android
Long	timestamp Timestamp in nanoseconds of the trace event.	android
TrackDescriptor?	trackDescriptor If not null, this TraceEvent initializes a track, and the TrackDescriptor defines its properties.	android
Long	trackUuid Set to the value of the containing Track's Track.uuid.	android
Int	type Must be one of TRACE_EVENT_TYPE_UNDEFINED, TRACE_EVENT_TYPE_INSTANT, TRACE_EVENT_TYPE_BEGIN, TRACE_EVENT_TYPE_END, TRACE_EVENT_TYPE_COUNTER	android

Public constructors

TraceEvent

android

Added in 2.0.0-rc01

TraceEvent()

Public functions

copyFrom

android

Added in 2.0.0-rc01

fun copyFrom(src: TraceEvent): Unit

reset

android

Added in 2.0.0-rc01

fun reset(): Unit

Public properties

attributes

android

Added in 2.0.0-rc01

var attributes: MutableList<AttributeEntry>

The list of trace attributes associated with the trace.

categories

android

Added in 2.0.0-rc01

var categories: MutableList<String>

The categories that this Trace Event belongs to.

correlationId

android

Added in 2.0.0-rc01

var correlationId: Long?

The optional correlation id associated with the event.

correlationIdString

android

Added in 2.0.0-rc01

var correlationIdString: String?

The optional correlation id as String that is associated with the event.

counterDoubleValue

android

Added in 2.0.0-rc01

var counterDoubleValue: Double?

Value of the trace event if the event type is TRACE_EVENT_TYPE_COUNTER.

Note that only one of counterDoubleValue and counterLongValue may be set.

counterLongValue

android

Added in 2.0.0-rc01

var counterLongValue: Long?

Value of the trace event if the event type is TRACE_EVENT_TYPE_COUNTER.

Note that only one of counterDoubleValue and counterLongValue may be set.

flowIds

android

Added in 2.0.0-rc01

var flowIds: List<Long>

List of trace flows associated with this event.

frames

android

Added in 2.0.0-rc01

var frames: MutableList<Frame>

A list of call stack frames that can be associated to the androidx.tracing.TraceEvent.

lastAttributeIndex

android

Added in 2.0.0-rc01

var lastAttributeIndex: Int

Keeping track of the index separately for attributes, because the MutableList is pre-allocated with sentinel objects for performance reasons. This index can be used to determine the true size of the attributes MutableList.

lastCategoryIndex

android

Added in 2.0.0-rc01

var lastCategoryIndex: Int

Keeping track of the index separately for categories, because the MutableList is pre-allocated with sentinel objects for performance reasons. This index can be used to determine the true size of the categories MutableList.

lastFrameIndex

android

Added in 2.0.0-rc01

var lastFrameIndex: Int

Keeping track of the index separately for frames, because the MutableList is pre-allocated with sentinel objects for performance reasons. This index can be used to determine the true size of the frames MutableList.

lastMetadataEntryIndex

android

Added in 2.0.0-rc01

var lastMetadataEntryIndex: Int

Keeping track of the index separately, because the MutableList is pre-allocated with sentinel objects for performance reasons. This index can be used to determine the true size of the metadataEntries MutableList.

metadataEntries

android

Added in 2.0.0-rc01

var metadataEntries: MutableList<MetadataEntry>

The list of debug annotations associated with a slice

name

android

Added in 2.0.0-rc01

var name: String?

Name of the trace event - null if the event type is TRACE_EVENT_TYPE_COUNTER.

primaryCategory

android

Added in 2.0.0-rc01

var primaryCategory: String

The primary category that this trace event belongs to.

timestamp

android

Added in 2.0.0-rc01

var timestamp: Long

Timestamp in nanoseconds of the trace event.

trackDescriptor

android

Added in 2.0.0-rc01

var trackDescriptor: TrackDescriptor?

If not null, this TraceEvent initializes a track, and the TrackDescriptor defines its properties.

trackUuid

android

Added in 2.0.0-rc01

var trackUuid: Long

Set to the value of the containing Track's Track.uuid.

type

android

Added in 2.0.0-rc01

var type: Int

Must be one of TRACE_EVENT_TYPE_UNDEFINED, TRACE_EVENT_TYPE_INSTANT, TRACE_EVENT_TYPE_BEGIN, TRACE_EVENT_TYPE_END, TRACE_EVENT_TYPE_COUNTER