ProfilingManager

class ProfilingManager
kotlin.Any
   ↳ android.os.ProfilingManager

API for apps to request and listen for app specific profiling.

Summary

Constants
static Int

Profiling type for requestProfiling to request a heap profile.
static Int

Profiling type for requestProfiling to request a java heap dump.
static Int

Profiling type for requestProfiling to request a stack sample.
static Int

Profiling type for requestProfiling to request a system trace.
Public methods
Unit

Register a listener to be called for all profiling results for this uid.
Unit
requestProfiling(profilingType: Int, parameters: Bundle?, tag: String?, cancellationSignal: CancellationSignal?, executor: Executor?, listener: Consumer<ProfilingResult!>?)

Request system profiling.
Unit

Unregister a listener that was to be called for all profiling results.

Constants

PROFILING_TYPE_HEAP_PROFILE

Added in API level VanillaIceCream
static val PROFILING_TYPE_HEAP_PROFILE: Int

Profiling type for requestProfiling to request a heap profile.

Value: 2

PROFILING_TYPE_JAVA_HEAP_DUMP

Added in API level VanillaIceCream
static val PROFILING_TYPE_JAVA_HEAP_DUMP: Int

Profiling type for requestProfiling to request a java heap dump.

Value: 1

PROFILING_TYPE_STACK_SAMPLING

Added in API level VanillaIceCream
static val PROFILING_TYPE_STACK_SAMPLING: Int

Profiling type for requestProfiling to request a stack sample.

Value: 3

PROFILING_TYPE_SYSTEM_TRACE

Added in API level VanillaIceCream
static val PROFILING_TYPE_SYSTEM_TRACE: Int

Profiling type for requestProfiling to request a system trace.

Value: 4

Public methods

registerForAllProfilingResults

Added in API level VanillaIceCream
fun registerForAllProfilingResults(
    executor: Executor, 
    listener: Consumer<ProfilingResult!>
): Unit

Register a listener to be called for all profiling results for this uid. Listeners set here will be called in addition to any provided with the request.

Parameters
executor Executor: The executor to call back with. This value cannot be null.
listener Consumer<ProfilingResult!>: Listener to be triggered with result. This value cannot be null.

requestProfiling

Added in API level VanillaIceCream
fun requestProfiling(
    profilingType: Int, 
    parameters: Bundle?, 
    tag: String?, 
    cancellationSignal: CancellationSignal?, 
    executor: Executor?, 
    listener: Consumer<ProfilingResult!>?
): Unit

Request system profiling.

Note: use of this API directly is not recommended for most use cases. Please use the higher level wrappers provided by androidx that will construct the request correctly based on available options and simplified user provided request parameters.

Note: requests are not guaranteed to be filled.

Note: Both a listener and executor must be set for the request to be considered for fulfillment. Listeners can be set in this method, with registerForAllProfilingResults, or both. If no listener and executor is set the request will be discarded.

Parameters
profilingType Int: Type of profiling to collect. Value is android.os.ProfilingManager#PROFILING_TYPE_JAVA_HEAP_DUMP, android.os.ProfilingManager#PROFILING_TYPE_HEAP_PROFILE, android.os.ProfilingManager#PROFILING_TYPE_STACK_SAMPLING, or android.os.ProfilingManager#PROFILING_TYPE_SYSTEM_TRACE
parameters Bundle?: Bundle of request related parameters. If the bundle contains any unrecognized parameters, the request will be fail with #ProfilingResult. If the values for the parameters are out of supported range, the closest possible in range value will be chosen. Use of androidx wrappers is recommended over generating this directly. This value may be null.
tag String?: Caller defined data to help identify the output. The first 20 alphanumeric characters, plus dashes, will be lowercased and included in the output filename. This value may be null.
cancellationSignal CancellationSignal?: for caller requested cancellation. Results will be returned if available. If this is null, the requesting app will not be able to stop the collection. The collection will stop after timing out with either the provided configurations or with system defaults
executor Executor?: The executor to call back with. Will only be used for the listener provided in this method. If this is null, and no global executor and listener combinations are registered at the time of the request, the request will be dropped.
listener Consumer<ProfilingResult!>?: Listener to be triggered with result. Any global listeners registered via registerForAllProfilingResults will also be triggered. If this is null, and no global listener and executor combinations are registered at the time of the request, the request will be dropped.

unregisterForAllProfilingResults

Added in API level VanillaIceCream
fun unregisterForAllProfilingResults(listener: Consumer<ProfilingResult!>?): Unit

Unregister a listener that was to be called for all profiling results. If no listener is provided, all listeners for this process that were not submitted with a profiling request will be removed.

Parameters
listener Consumer<ProfilingResult!>?: Listener to unregister and no longer be triggered with the results. Null to remove all global listeners for this uid. This value may be null.