TracingConfig.Builder
class TracingConfig.Builder
Builder used to create TracingConfig objects.
Examples:
// Create a configuration with default options:CATEGORIES_NONE, //RECORD_CONTINUOUSLY.new TracingConfig.Builder().build()
// Record trace events from the "web developer" predefined category sets.
// Uses a ring buffer (the default RECORD_CONTINUOUSLY mode) for
// internal storage during tracing.
new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER).build()
// Record trace events from the "rendering" and "input latency" predefined // category sets.
new TracingConfig.Builder().addCategories(CATEGORIES_RENDERING, CATEGORIES_INPUT_LATENCY).build()
// Record only the trace events from the "browser" category.
new TracingConfig.Builder().addCategories("browser").build()
// Record only the trace events matching the "blink*" and "renderer*" patterns // (e.g. "blink.animations", "renderer_host" and "renderer.scheduler" categories).
new TracingConfig.Builder().addCategories("blink*","renderer*").build()
// Record events from the "web developer" predefined category set and events from // the "disabled-by-default-v8.gc" category to understand where garbage collection // is being triggered. Uses a limited size buffer for internal storage during tracing.
new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER) .addCategories("disabled-by-default-v8.gc") .setTracingMode(RECORD_UNTIL_FULL).build()
Summary
Public constructors |
|---|
Builder()Default constructor for Builder. |
Public functions |
|
|---|---|
TracingConfig.Builder |
addCategories(categories: Array<String!>)Adds custom categories to be included in trace output. |
TracingConfig.Builder |
addCategories(categories: (Mutable)Collection<String!>)Adds custom categories to be included in trace output. |
TracingConfig.Builder |
addCategories(predefinedCategories: IntArray)Adds predefined sets of categories to be included in the trace output. |
TracingConfig |
build()Build |
TracingConfig.Builder |
setTracingMode(tracingMode: Int)Sets the tracing mode for this configuration. |
Public functions
addCategories
fun addCategories(categories: Array<String!>): TracingConfig.Builder
Adds custom categories to be included in trace output.
Note that the categories are defined by the currently-in-use version of WebView. They live in chromium code and are not part of the Android API. See chromium documentation on tracing for more details.
| Parameters | |
|---|---|
categories: Array<String!> |
A list of category patterns. A category pattern can contain wildcards, e.g. "blink*" or full category name e.g. "renderer.scheduler". |
| Returns | |
|---|---|
TracingConfig.Builder |
The builder to facilitate chaining. |
addCategories
fun addCategories(categories: (Mutable)Collection<String!>): TracingConfig.Builder
Adds custom categories to be included in trace output.
Same as addCategories but allows to pass a Collection as a parameter.
| Parameters | |
|---|---|
categories: (Mutable)Collection<String!> |
A list of category patterns. |
| Returns | |
|---|---|
TracingConfig.Builder |
The builder to facilitate chaining. |
addCategories
fun addCategories(predefinedCategories: IntArray): TracingConfig.Builder
Adds predefined sets of categories to be included in the trace output.
A predefined category set can be one of CATEGORIES_NONE, CATEGORIES_ALL, CATEGORIES_ANDROID_WEBVIEW, CATEGORIES_WEB_DEVELOPER, CATEGORIES_INPUT_LATENCY, CATEGORIES_RENDERING, CATEGORIES_JAVASCRIPT_AND_RENDERING or CATEGORIES_FRAME_VIEWER.
| Parameters | |
|---|---|
predefinedCategories: IntArray |
A list or bitmask of predefined category sets. |
| Returns | |
|---|---|
TracingConfig.Builder |
The builder to facilitate chaining. |
build
fun build(): TracingConfig
Build TracingConfig using the current settings.
| Returns | |
|---|---|
TracingConfig |
The |
setTracingMode
fun setTracingMode(tracingMode: Int): TracingConfig.Builder
Sets the tracing mode for this configuration. When tracingMode is not set explicitly, the default is RECORD_CONTINUOUSLY.
| Parameters | |
|---|---|
tracingMode: Int |
The tracing mode to use, one of |
| Returns | |
|---|---|
TracingConfig.Builder |
The builder to facilitate chaining. |