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

TraceCapabilities

class TraceCapabilities(val threadIdentity: Boolean, val systemTraceIntegration: Boolean, val counters: Boolean, val flows: Boolean)(source)

What the current target can do for tracing out of the box, as shipped in :runtime. This is the extension seam for new platforms: a target compiles and works with every flag false, and gains fidelity when someone writes its actual of platformCapabilities and platformTraceSink.

A missing capability degrades, it never fails: a sink without thread identity omits it, and one that cannot draw flows ignores parentSpanId. A plain final class (not a data class) so flags can be added later without a binary-incompatible copy/componentN change.

Example:

if (platformCapabilities.counters) println("pending/running tracks are available")

Constructors

TraceCapabilities

constructor(threadIdentity: Boolean, systemTraceIntegration: Boolean, counters: Boolean, flows: Boolean)

Creates a capability descriptor; mainly useful for custom platform backends and tests.

Properties

counters

val counters: Boolean

that default sink publishes pending/running counter tracks.

flows

val flows: Boolean

that default sink draws span links from parentSpanId.

systemTraceIntegration

val systemTraceIntegration: Boolean

:runtime ships a sink for this target's system tracer (see platformTraceSink). Backends in separate artifacts, such as :runtime-tracing, do not count.

threadIdentity

val threadIdentity: Boolean

run events carry a real ThreadInfo on this target.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String