SystemTraceRequestBuilder

Added in 1.15.0

Kotlin |Java

@RequiresApi(api = 35)
public final class SystemTraceRequestBuilder extends ProfilingRequestBuilder

java.lang.Object
↳	androidx.core.os.ProfilingRequestBuilder
	↳	androidx.core.os.SystemTraceRequestBuilder

Request builder to create a request for a system trace from ProfilingManager.

val listener =
    Consumer<ProfilingResult> { profilingResult ->
        if (profilingResult.errorCode == ProfilingResult.ERROR_NONE) {
            doSomethingWithMyFile(profilingResult.resultFilePath)
        } else {
            doSomethingWithFailure(profilingResult.errorCode, profilingResult.errorMessage)
        }
    }

val cancellationSignal = CancellationSignal()

requestProfiling(
    context,
    SystemTraceRequestBuilder()
        .setBufferSizeKb(1000 /* Requested buffer size in KB */)
        .setDurationMs(60 * 1000 /* Requested profiling duration in millisconds */)
        .setBufferFillPolicy(BufferFillPolicy.RING_BUFFER /* Buffer fill policy */)
        .setTag("tag" /* Caller supplied tag for identification */)
        .setCancellationSignal(cancellationSignal)
        .build(),
    Dispatchers.IO.asExecutor(), // Your choice of executor for the callback to occur on.
    listener,
)

// Optionally, wait for something interesting to happen and then stop the profiling to receive
// the result as is.
cancellationSignal.cancel()

Summary

Public constructors
`SystemTraceRequestBuilder()`

Public methods
`final @NonNull SystemTraceRequestBuilder`	`setBufferFillPolicy(@NonNull BufferFillPolicy bufferFillPolicy)` Set the buffer fill policy.
`final @NonNull SystemTraceRequestBuilder`	`setBufferSizeKb(int bufferSizeKb)` Set the buffer size in kilobytes for this profiling request.
`final @NonNull SystemTraceRequestBuilder`	`setDurationMs(int durationMs)` Set the duration in milliseconds for this profiling request.

Inherited methods

From androidx.core.os.ProfilingRequestBuilder

`final @NonNull ProfilingRequest`	`build()` Build the `ProfilingRequest` object which can be used with `requestProfiling` to request profiling.
`final @NonNull SystemTraceRequestBuilder`	`setCancellationSignal(@NonNull CancellationSignal cancellationSignal)` Set a CancellationSignal to request cancellation of the requested trace.
`final @NonNull SystemTraceRequestBuilder`	`setTag(@NonNull String tag)` Add data to help identify the output.

Public constructors

SystemTraceRequestBuilder

Added in 1.15.0

public SystemTraceRequestBuilder()

Public methods

setBufferFillPolicy

Added in 1.15.0

public final @NonNull SystemTraceRequestBuilder setBufferFillPolicy(@NonNull BufferFillPolicy bufferFillPolicy)

Set the buffer fill policy.

setBufferSizeKb

Added in 1.15.0

public final @NonNull SystemTraceRequestBuilder setBufferSizeKb(int bufferSizeKb)

Set the buffer size in kilobytes for this profiling request.

setDurationMs

Added in 1.15.0

public final @NonNull SystemTraceRequestBuilder setDurationMs(int durationMs)

Set the duration in milliseconds for this profiling request.