Skip to content

ElectronContentTracing

Unofficial

Collects tracing data from Chromium’s content module for finding performance bottlenecks and slow operations.

Import:

import type { ElectronContentTracing } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronContentTracing

Methods

Method Returns Description
getCategories() Promise<string[]> Get a set of category groups. The category groups can change as new code paths are reached. See also the list of built-in tracing categories.
getTraceBufferUsage() Promise<ElectronTraceBufferUsageReturnValue> Get the maximum usage across processes of the trace buffer as a percentage of the full state.
startRecording(options) Promise<void> Start recording on all processes.

Recording begins immediately locally and asynchronously on child processes as soon as they receive the EnableRecording request. If a recording is already running, the promise will be immediately resolved, as only one trace operation can be in progress at a time.
stopRecording(resultFilePath?) Promise<string> Stop recording on all processes.

Trace data will be written into resultFilePath. If resultFilePath is empty or not provided, trace data will be written to a temporary file, and the path will be returned in the promise.

Links to this page: