Перейти к основному содержанию

contentTracing

Собирает данные трассировки из содержимого модуля Chromium для поиска узких мест производительности и медленных операций.

ProcessMain

Этот модуль не содержит веб-интерфейса. Traces are recorded in the Perfetto protobuf format; to view them, open them in the Perfetto UI.

[!NOTE] You should not use this module until the ready event of the app module is emitted.

const { app, contentTracing } = require('electron')

app.whenReady().then(async () => {
await contentTracing.startRecording({
included_categories: ['*']
})
console.log('Tracing started')
await new Promise((resolve) => setTimeout(resolve, 5000))
const path = await contentTracing.stopRecording()
console.log('Tracing data recorded to ' + path)
})

Методы​

Модуль contentTracing имеет следующие методы:

contentTracing.getCategories()​

History

Возвращает Promise<string[]> - возвращает массив групп категорий, как только все дочерние процессы признают запрос getCategories

Получить набор групп категорий. Группы категорий могут меняться при достижении новых путей кода. See also the list of built-in tracing categories.

NOTE: Electron adds a non-default tracing category called "electron". This category can be used to capture Electron-specific tracing events.

contentTracing.startRecording(options)​

History
Version(s)Changes
None

The options parameter now accepts TraceConfig in addition to TraceCategoriesAndOptions.

None

This function now returns a callbackPromise<void>.

None

Added the nativeHeapProfiling option to enable native heap profiling.

Возвращает Promise<void> - возвращается, как только все дочерние процессы признают запрос startRecording.

Начинает запись во всех процессах.

Запись начинается незамедлительно локально и ассинхронно в дочерних процессах, как только они получили запрос EnableRecording.

Если запись уже запущена, promise будет немедленно разрешен, поскольку одновременно может выполняться только одна операция трассировки. If options.nativeHeapProfiling is set while a recording is already running, the promise is rejected instead, since the already-running recording's options can't be changed to turn on heap profiling.

contentTracing.stopRecording([resultFilePath])​

History
  • resultFilePath string (опционально)

Возвращает Promise<string> - возвращает путь к файлу, который содержит данные трассировки, как только все дочерние процессы признают запрос stopRecording

Останавливает запись во всех процессах.

Дочерние процессы кэшируют данные трассировки и только изредка очищают и отправляют эти данные обратно в главный процесс. Это помогает свести к минимуму издержки трассировки, так как отправка данных трассировки через IPC может быть дорогостоящей операцией. Поэтому, чтобы окончить Chromium ассинхронно запрашивает все дочерние процессы, чтобы очистить оставшиеся данные трассировки.

Данные трассировки будут записаны в resultFilePath. Если resultFilePath является пустым или не указано, Данные трассировки будут записаны во временный файл, и путь будет возвращен в promise.

Trace data is written in the Perfetto protobuf format.

Heap profiling samples record instruction addresses and module build IDs rather than function names. To symbolize them, use the symbols published for the matching Electron release with Chromium's symbolize_trace tool.

contentTracing.getTraceBufferUsage()​

History

Возвращает Promise <Object> - разрешается с объектом, содержащим value и percentage максимального использования буфера трассировки

  • value number
  • percentage number

Максимальное использование в различных процессах буфера трассировки в процентах от полного состояния.