TraceEvent

Kotlin |Java

Cmn
```
@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()`	Cmn

Public functions
`Unit`	`reset()`	Cmn

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

Public constructors

TraceEvent

Cmn

Added in 2.0.0-alpha01

TraceEvent()

Public functions

reset

Cmn

Added in 2.0.0-alpha01

fun reset(): Unit

Public properties

correlationId

Cmn

Added in 2.0.0-alpha01

var correlationId: Long?

The optional correlation id associated with the event.

correlationIdString

Cmn

Added in 2.0.0-alpha01

var correlationIdString: String?

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

counterDoubleValue

Cmn

Added in 2.0.0-alpha01

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

Cmn

Added in 2.0.0-alpha01

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

Cmn

Added in 2.0.0-alpha01

var flowIds: List<Long>

List of trace flows associated with this event.

frames

Cmn

Added in 2.0.0-alpha01

var frames: MutableList<Frame>

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

lastCategoryIndex

Cmn

Added in 2.0.0-alpha01

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

Cmn

Added in 2.0.0-alpha01

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

Cmn

Added in 2.0.0-alpha01

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

Cmn

Added in 2.0.0-alpha01

var metadataEntries: MutableList<MetadataEntry>

The list of debug annotations associated with a slice

name

Cmn

Added in 2.0.0-alpha01

var name: String?

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

primaryCategory

Cmn

Added in 2.0.0-alpha01

var primaryCategory: String

The primary category that this trace event belongs to.

timestamp

Cmn

Added in 2.0.0-alpha01

var timestamp: Long

Timestamp in nanoseconds of the trace event.

trackDescriptor

Cmn

Added in 2.0.0-alpha01

var trackDescriptor: TrackDescriptor?

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

trackUuid

Cmn

Added in 2.0.0-alpha01

var trackUuid: Long

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

type

Cmn

Added in 2.0.0-alpha01

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