TraceConfig (fable-electron-docs-api)

TraceConfig Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Types
Base Type: obj

An example TraceConfig that roughly matches what Chrome DevTools records:

Constructors

Constructor Description

Constructor	Description
`TraceConfig(?recordingMode, ?traceBufferSizeInKb, ?traceBufferSizeInEvents, ?enableArgumentFilter, ?includedCategories, ?excludedCategories, ?includedProcessIds, ?histogramNames, ?memoryDumpConfig)` Full Usage: `TraceConfig(?recordingMode, ?traceBufferSizeInKb, ?traceBufferSizeInEvents, ?enableArgumentFilter, ?includedCategories, ?excludedCategories, ?includedProcessIds, ?histogramNames, ?memoryDumpConfig)` Parameters: ?recordingMode : `RecordingMode` - Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`. Defaults to `record-until-full`. ?traceBufferSizeInKb : `float` - maximum size of the trace recording buffer in kilobytes. Defaults to 100MB. ?traceBufferSizeInEvents : `float` - maximum size of the trace recording buffer in events. ?enableArgumentFilter : `bool` - if true, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics. ?includedCategories : `string[]` - 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. ?excludedCategories* : `string[]` - 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. ?includedProcessIds* : `float[]` - a list of process IDs to include in the trace. If not specified, trace all processes. ?histogramNames : `string[]` - a list of histogram names to report with the trace. ?memoryDumpConfig : `Record<string, obj>` - if the `disabled-by-default-memory-infra` category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information. Returns: `TraceConfig`	?recordingMode : `RecordingMode` Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`. Defaults to `record-until-full`. ?traceBufferSizeInKb : `float` maximum size of the trace recording buffer in kilobytes. Defaults to 100MB. ?traceBufferSizeInEvents : `float` maximum size of the trace recording buffer in events. ?enableArgumentFilter : `bool` if true, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics. ?includedCategories : `string[]` 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. ?excludedCategories : `string[]` 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. ?includedProcessIds : `float[]` a list of process IDs to include in the trace. If not specified, trace all processes. ?histogramNames : `string[]` a list of histogram names to report with the trace. ?memoryDumpConfig : `Record<string, obj>` if the `disabled-by-default-memory-infra` category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information. Returns: `TraceConfig`


                
                  
                    
                      TraceConfig(?recordingMode, ?traceBufferSizeInKb, ?traceBufferSizeInEvents, ?enableArgumentFilter, ?includedCategories, ?excludedCategories, ?includedProcessIds, ?histogramNames, ?memoryDumpConfig)

Full Usage:

TraceConfig(?recordingMode, ?traceBufferSizeInKb, ?traceBufferSizeInEvents, ?enableArgumentFilter, ?includedCategories, ?excludedCategories, ?includedProcessIds, ?histogramNames, ?memoryDumpConfig)

Parameters:

?recordingMode : RecordingMode - Can be record-until-full, record-continuously, record-as-much-as-possible or trace-to-console. Defaults to record-until-full.

?traceBufferSizeInKb : float - maximum size of the trace recording buffer in kilobytes. Defaults to 100MB.

?traceBufferSizeInEvents : float - maximum size of the trace recording buffer in events.

?enableArgumentFilter : bool - if true, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics.

?includedCategories : string[] - 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.

?excludedCategories : string[] - 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.

?includedProcessIds : float[] - a list of process IDs to include in the trace. If not specified, trace all processes.

?histogramNames : string[] - a list of histogram names to report with the trace.

?memoryDumpConfig : Record<string, obj> - if the disabled-by-default-memory-infra category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information.

Returns: TraceConfig

?recordingMode : RecordingMode: Can be record-until-full, record-continuously, record-as-much-as-possible or trace-to-console. Defaults to record-until-full.
?traceBufferSizeInKb : float: maximum size of the trace recording buffer in kilobytes. Defaults to 100MB.
?traceBufferSizeInEvents : float: maximum size of the trace recording buffer in events.
?enableArgumentFilter : bool: if true, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics.
?includedCategories : string[]: 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.
?excludedCategories : string[]: 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.
?includedProcessIds : float[]: a list of process IDs to include in the trace. If not specified, trace all processes.
?histogramNames : string[]: a list of histogram names to report with the trace.
?memoryDumpConfig : Record<string, obj>: if the disabled-by-default-memory-infra category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information.

Returns: TraceConfig

Instance members

Instance member	Description
`this.enableArgumentFilter` Full Usage: `this.enableArgumentFilter`	if true, filter event data according to a specific list of events that have been manually vetted to not include any PII. See the implementation in Chromium for specifics.
`this.excludedCategories` Full Usage: `this.excludedCategories`	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.
`this.histogramNames` Full Usage: `this.histogramNames`	a list of histogram names to report with the trace.
`this.includedCategories` Full Usage: `this.includedCategories`	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.
`this.includedProcessIds` Full Usage: `this.includedProcessIds`	a list of process IDs to include in the trace. If not specified, trace all processes.
`this.memoryDumpConfig` Full Usage: `this.memoryDumpConfig`	if the disabled-by-default-memory-infra category is enabled, this contains optional additional configuration for data collection. See the Chromium memory-infra docs for more information.
`this.recordingMode` Full Usage: `this.recordingMode`	Can be record-until-full, record-continuously, record-as-much-as-possible or trace-to-console. Defaults to record-until-full.
`this.traceBufferSizeInEvents` Full Usage: `this.traceBufferSizeInEvents`	maximum size of the trace recording buffer in events.
`this.traceBufferSizeInKb` Full Usage: `this.traceBufferSizeInKb`	maximum size of the trace recording buffer in kilobytes. Defaults to 100MB.