0.2.5

cdp/dev.kdriver.cdp.domain/Performance

Performance

class Performance(cdp: CDP) : Domain

Constructors

constructor(cdp: CDP)

Types

EnableParameter

@Serializable

data class EnableParameter(val timeDomain: String? = null)

GetMetricsReturn

@Serializable

data class GetMetricsReturn(val metrics: List<Performance.Metric>)

@Serializable

data class Metric(val name: String, val value: Double)

Run-time execution metric.

MetricsParameter

@Serializable

data class MetricsParameter(val metrics: List<Performance.Metric>, val title: String)

Current values of the metrics.

SetTimeDomainParameter

@Serializable

data class SetTimeDomainParameter(val timeDomain: String)

Properties

val metrics: Flow<Performance.MetricsParameter>

Current values of the metrics.

Functions

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disable collecting and reporting metrics.

suspend fun enable(timeDomain: String? = null)

suspend fun enable(args: Performance.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable collecting and reporting metrics.

suspend fun getMetrics(mode: CommandMode = CommandMode.DEFAULT): Performance.GetMetricsReturn

Retrieve current values of run-time metrics.

suspend fun ~~setTimeDomain~~(timeDomain: String)

suspend fun ~~setTimeDomain~~(args: Performance.SetTimeDomainParameter, mode: CommandMode = CommandMode.DEFAULT)

Sets time domain to use for collecting and reporting duration metrics. Note that this must be called before enabling metrics collection. Calling this method while metrics collection is enabled returns an error.