cfd230d7f1
* docs: remove implicit 'any' and 'Object' types from the docs * docs: more docs improvements, remove all remaining empty interfaces * chore: update tests for better types
51 lines
2.6 KiB
Markdown
51 lines
2.6 KiB
Markdown
# TraceConfig Object
|
|
|
|
* `recording_mode` String (optional) - Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`. Defaults to `record-until-full`.
|
|
* `trace_buffer_size_in_kb` number (optional) - maximum size of the trace
|
|
recording buffer in kilobytes. Defaults to 100MB.
|
|
* `trace_buffer_size_in_events` number (optional) - maximum size of the trace
|
|
recording buffer in events.
|
|
* `enable_argument_filter` boolean (optional) - if true, filter event data
|
|
according to a whitelist of events that have been manually vetted to not
|
|
include any PII. See [the implementation in
|
|
Chromium][trace_event_args_whitelist.cc] for specifics.
|
|
* `included_categories` String[] (optional) - a list of tracing categories to
|
|
include. Can include glob-like patterns using `*` at the end of the category
|
|
name. See [tracing categories][] for the list of categories.
|
|
* `excluded_categories` String[] (optional) - a list of tracing categories to
|
|
exclude. Can include glob-like patterns using `*` at the end of the category
|
|
name. See [tracing categories][] for the list of categories.
|
|
* `included_process_ids` number[] (optional) - a list of process IDs to
|
|
include in the trace. If not specified, trace all processes.
|
|
* `histogram_names` String[] (optional) - a list of [histogram][] names to report
|
|
with the trace.
|
|
* `memory_dump_config` Record<String, any> (optional) - if the
|
|
`disabled-by-default-memory-infra` category is enabled, this contains
|
|
optional additional configuration for data collection. See the [Chromium
|
|
memory-infra docs][memory-infra docs] for more information.
|
|
|
|
An example TraceConfig that roughly matches what Chrome DevTools records:
|
|
|
|
```js
|
|
{
|
|
recording_mode: 'record-until-full',
|
|
included_categories: [
|
|
'devtools.timeline',
|
|
'disabled-by-default-devtools.timeline',
|
|
'disabled-by-default-devtools.timeline.frame',
|
|
'disabled-by-default-devtools.timeline.stack',
|
|
'v8.execute',
|
|
'blink.console',
|
|
'blink.user_timing',
|
|
'latencyInfo',
|
|
'disabled-by-default-v8.cpu_profiler',
|
|
'disabled-by-default-v8.cpu_profiler.hires'
|
|
],
|
|
excluded_categories: [ '*' ]
|
|
}
|
|
```
|
|
|
|
[tracing categories]: https://chromium.googlesource.com/chromium/src/+/master/base/trace_event/builtin_categories.h
|
|
[memory-infra docs]: https://chromium.googlesource.com/chromium/src/+/master/docs/memory-infra/memory_infra_startup_tracing.md#the-advanced-way
|
|
[trace_event_args_whitelist.cc]: https://chromium.googlesource.com/chromium/src/+/master/services/tracing/public/cpp/trace_event_args_whitelist.cc
|
|
[histogram]: https://chromium.googlesource.com/chromium/src.git/+/HEAD/tools/metrics/histograms/README.md
|