structured-coroutines-runtime/io.github.santimattius.structured.runtime/TraceLevel

TraceLevel

enum TraceLevel : Enum<TraceLevel> (source)

How much detail a TraceSink wants to receive. Levels are cumulative by ordinal: enabling a level also enables every level below it, so level <= maxLevel is the enablement test.

Dispatch: queued, started and finished events per dispatch. The cheapest useful level.
Coroutine: additionally populates the coroutine name and the thread identity on run events (where the platform supports it).
Pool: additionally enables periodic TraceEvent.PoolSamples, produced by PoolSampler.

New levels can be appended in the future without breaking existing sinks.

Example:

val enabled = TraceLevel.Dispatch <= TraceLevel.Coroutine // true

Requires opting in to ExperimentalStructuredCoroutines.

Entries

Dispatch

Queued, started and finished events.

Coroutine

Adds coroutine name and thread identity on run events.

Pool

Adds periodic pool samples (TraceEvent.PoolSample).

Properties

entries

val entries: EnumEntries<TraceLevel>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): TraceLevel

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TraceLevel>

Returns an array containing the constants of this enum type, in the order they're declared.