TracingController

Kotlin |Java

abstract class TracingController

kotlin.Any
↳	android.webkit.TracingController

Manages tracing of WebViews. In particular provides functionality for the app to enable/disable tracing of parts of code and to collect tracing data. This is useful for profiling performance issues, debugging and memory usage analysis in production and real life scenarios.

The resulting trace data is sent back as a byte sequence in json format. This file can be loaded in "chrome://tracing" for further analysis.

Example usage:

TracingController tracingController = TracingController.getInstance();
  tracingController.start(new TracingConfig.Builder()
                   .addCategories(TracingConfig.CATEGORIES_WEB_DEVELOPER).build());
  ...
  tracingController.stop(new FileOutputStream("trace.json"),
                         Executors.newSingleThreadExecutor());

Summary

Public constructors
`TracingController()`

Public methods
open static TracingController	`getInstance()` Returns the default TracingController instance.
abstract Boolean	`isTracing()` Returns whether the WebView framework is tracing.
abstract Unit	`start(tracingConfig: TracingConfig)` Starts tracing all webviews.
abstract Boolean	`stop(outputStream: OutputStream?, executor: Executor)` Stops tracing and flushes tracing data to the specified outputStream.

Public constructors

TracingController

Added in API level 28

TracingController()

Deprecated: This class should not be constructed by applications, use getInstance instead to fetch the singleton instance.

Public methods

getInstance

Added in API level 28

open static fun getInstance(): TracingController

Returns the default TracingController instance. At present there is only one TracingController instance for all WebView instances, however this restriction may be relaxed in a future Android release.

Return
`TracingController`	The default TracingController instance. This value cannot be `null`.

isTracing

Added in API level 28

abstract fun isTracing(): Boolean

Returns whether the WebView framework is tracing.

Return
`Boolean`	True if tracing is enabled.

start

Added in API level 28

abstract fun start(tracingConfig: TracingConfig): Unit

Starts tracing all webviews. Depending on the trace mode in traceConfig specifies how the trace events are recorded. For tracing modes TracingConfig.RECORD_UNTIL_FULL and TracingConfig.RECORD_CONTINUOUSLY the events are recorded using an internal buffer and flushed to the outputStream when stop(java.io.OutputStream,java.util.concurrent.Executor) is called.

Parameters
`tracingConfig`	TracingConfig: Configuration options to use for tracing. This value cannot be `null`.

Exceptions
`java.lang.IllegalStateException`	If the system is already tracing.
`java.lang.IllegalArgumentException`	If the configuration is invalid (e.g. invalid category pattern or invalid tracing mode).

stop

Added in API level 28

abstract fun stop(
    outputStream: OutputStream?, 
    executor: Executor
): Boolean

Stops tracing and flushes tracing data to the specified outputStream. The data is sent to the specified output stream in json format typically in chunks by invoking java.io.OutputStream#write(byte[]). On completion the java.io.OutputStream#close() method is called.

Parameters

outputStream OutputStream?: The output stream the tracing data will be sent to. If null the tracing data will be discarded.

executor Executor: The java.util.concurrent.Executor on which the outputStream java.io.OutputStream#write(byte[]) and java.io.OutputStream#close() methods will be invoked. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

Parameters
`outputStream`	OutputStream?: The output stream the tracing data will be sent to. If null the tracing data will be discarded.
`executor`	Executor: The `java.util.concurrent.Executor` on which the outputStream `java.io.OutputStream#write(byte[])` and java.io.OutputStream#close() methods will be invoked. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.

Return
`Boolean`	False if the WebView framework was not tracing at the time of the call, true otherwise.