2018-12-20 13:11:17 +01:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								# TraceConfig Object
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-11-16 05:13:18 +01: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 14:15:42 -07: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 11:29:29 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  according to a specific list of events that have been manually vetted to not
							 
						 
					
						
							
								
									
										
										
										
											2024-06-10 08:14:03 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  include any PII. See [the implementation in Chromium][trace_event_args_allowlist.cc]
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								  for specifics.
							 
						 
					
						
							
								
									
										
										
										
											2021-11-16 05:13:18 +01:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								*  `included_categories`  string[] (optional) - a list of tracing categories to
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07: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 05:13:18 +01:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								*  `excluded_categories`  string[] (optional) - a list of tracing categories to
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07: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 05:13:18 +01:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								*  `histogram_names`  string[] (optional) - a list of [histogram][] names to report
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  with the trace.
							 
						 
					
						
							
								
									
										
										
										
											2024-03-25 03:19:44 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								*  `memory_dump_config`  Record\<string, any\> (optional) - if the
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  `disabled-by-default-memory-infra`  category is enabled, this contains
							 
						 
					
						
							
								
									
										
										
										
											2024-06-10 08:14:03 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  optional additional configuration for data collection. See the
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								  [Chromium memory-infra docs][memory-infra docs] for more information.
							 
						 
					
						
							
								
									
										
										
										
											2018-12-20 13:11:17 +01:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								An example TraceConfig that roughly matches what Chrome DevTools records:
							 
						 
					
						
							
								
									
										
										
										
											2018-12-20 13:11:17 +01:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-05-29 12:45:26 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								<!--  eslint - skip  --> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07: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 10:18:49 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								  excluded_categories: ['*']
							 
						 
					
						
							
								
									
										
										
										
											2019-05-28 14:15:42 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-03-17 05:45:55 -07: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 14:15:42 -07:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								[histogram]: https://chromium.googlesource.com/chromium/src.git/+/HEAD/tools/metrics/histograms/README.md