2018-12-20 12:11:17 +00:00
# TraceConfig Object
2021-11-16 04:13:18 +00:00
* `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` .
2019-05-28 21:15:42 +00:00
* `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
2020-06-09 18:29:29 +00:00
according to a specific list of events that have been manually vetted to not
2019-05-28 21:15:42 +00:00
include any PII. See [the implementation in
2022-03-17 12:45:55 +00:00
Chromium][trace_event_args_allowlist.cc] for specifics.
2021-11-16 04:13:18 +00:00
* `included_categories` string[] (optional) - a list of tracing categories to
2019-05-28 21:15:42 +00:00
include. Can include glob-like patterns using `*` at the end of the category
name. See [tracing categories][] for the list of categories.
2021-11-16 04:13:18 +00:00
* `excluded_categories` string[] (optional) - a list of tracing categories to
2019-05-28 21:15:42 +00:00
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.
2021-11-16 04:13:18 +00:00
* `histogram_names` string[] (optional) - a list of [histogram][] names to report
2019-05-28 21:15:42 +00:00
with the trace.
2021-11-16 04:13:18 +00:00
* `memory_dump_config` Record< string , any > (optional) - if the
2019-05-28 21:15:42 +00:00
`disabled-by-default-memory-infra` category is enabled, this contains
2019-06-21 21:19:21 +00:00
optional additional configuration for data collection. See the [Chromium
2019-05-28 21:15:42 +00:00
memory-infra docs][memory-infra docs] for more information.
2018-12-20 12:11:17 +00:00
2019-05-28 21:15:42 +00:00
An example TraceConfig that roughly matches what Chrome DevTools records:
2018-12-20 12:11:17 +00:00
2019-05-28 21:15:42 +00:00
```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'
],
2020-07-09 17:18:49 +00:00
excluded_categories: ['*']
2019-05-28 21:15:42 +00:00
}
```
2022-03-17 12:45:55 +00:00
[tracing categories]: https://chromium.googlesource.com/chromium/src/+/main/base/trace_event/builtin_categories.h
[memory-infra docs]: https://chromium.googlesource.com/chromium/src/+/main/docs/memory-infra/memory_infra_startup_tracing.md#the-advanced-way
[trace_event_args_allowlist.cc]: https://chromium.googlesource.com/chromium/src/+/main/services/tracing/public/cpp/trace_event_args_allowlist.cc
2019-05-28 21:15:42 +00:00
[histogram]: https://chromium.googlesource.com/chromium/src.git/+/HEAD/tools/metrics/histograms/README.md