MicrobenchmarkConfig

Artifact: androidx.benchmark:benchmark-common

View Source

Added in 1.2.0

---

Kotlin |Java

@ExperimentalBenchmarkConfigApi
class MicrobenchmarkConfig

---

Experimental config object for microbenchmarks for defining custom metrics, tracing behavior, and profiling, which overrides options set in instrumentation arguments.

Summary

Public constructors
MicrobenchmarkConfig(     metrics: List<MetricCapture>,     traceAppTagEnabled: Boolean,     perfettoSdkTracingEnabled: Boolean,     profiler: ProfilerConfig? )

Public properties
List<MetricCapture>	metrics Timing metrics for primary phase, post-warmup
Boolean	perfettoSdkTracingEnabled Set to true to enable capture of tracing-perfetto trace events, such as in Compose composition tracing.
ProfilerConfig?	profiler Optional profiler to be used after the primary timing phase.
Boolean	traceAppTagEnabled Set to true to enable capture of trace("foo") {} blocks in the output Perfetto trace.

Public constructors

MicrobenchmarkConfig

MicrobenchmarkConfig(
    metrics: List<MetricCapture> = listOf(TimeCapture()),
    traceAppTagEnabled: Boolean = false,
    perfettoSdkTracingEnabled: Boolean = false,
    profiler: ProfilerConfig? = null
)

Public properties

metrics

Added in 1.2.0

val metrics: List<MetricCapture>

Timing metrics for primary phase, post-warmup

Defaults to TimeCapture.

perfettoSdkTracingEnabled

Added in 1.3.0-alpha03

val perfettoSdkTracingEnabled: Boolean

Set to true to enable capture of tracing-perfetto trace events, such as in Compose composition tracing.

Defaults to false to minimize interference.

profiler

Added in 1.2.0

val profiler: ProfilerConfig?

Optional profiler to be used after the primary timing phase.

traceAppTagEnabled

Added in 1.3.0-alpha03

val traceAppTagEnabled: Boolean

Set to true to enable capture of trace("foo") {} blocks in the output Perfetto trace.

Defaults to false to minimize interference.