Aller au contenu principal

contentTracing

Collecte des données de traçage de Chromium pour trouver les goulets d'étranglement altérant les performance et les opérations trop lentes.

ProcessMain

Ce module n'inclut pas d'interface web. 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)
})

Méthodes​

Le module contentTracing possède les méthodes suivantes :

contentTracing.getCategories()​

History

Retourne une Promise<string[]> - qui se résout avec un tableau de groupes de catégories une fois que tous les processus enfants ont reconnu la requête getCategories

Retourne un ensemble de groupes de catégories. Les groupes de catégories peuvent changer lorsque de nouveaux chemins de code sont atteints. See also the list of built-in tracing categories.

NOTE: Electron adds a non-default tracing category called "electron". Cette catégorie peut être utilisée pour capturer des événements de traçage spécifiques à Electron.

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.

Retourne Promise<void> - résolu une fois que tous les processus enfants ont reconnu la requête startRecording.

Commencez à enregistrer sur tous les processus.

L'enregistrement commence immédiatement localement et de manière asynchrone sur les processus enfants dès qu'il reçoit la demande EnableRecording.

Si un enregistrement est déjà en cours, la promesse sera immédiatement résolue, car seule une opération de trace peut être en cours à la fois. 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 (facultatif)

Retourne Promise<string> - résout avec un chemin vers un fichier qui contient les données tracées une fois que tous les processus enfants ont reconnu la requête stopRecording

Arrêter l'enregistrement sur tous les processus.

Les processus fils mettent généralement en cache les données de trace et ne suppriment que rarement et envoient données de trace au processus principal. Cela aide à minimiser les frais d'exécution de traçage puisque l'envoi de données de traces via IPC peut être une opération coûteuse. Ainsi, pour terminer le traçage, Chromium demande asynchrone à tous les processus enfants de vider les données de traces en attente.

Les données de trace seront écrites dans resultFilePath. Si resultFilePath est vide ou non fourni, les données de trace seront écrites dans un fichier temporaire, et le chemin sera retourné dans la promesse.

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

Retourne Promise<Object> - Résolution avec un objet contenant la valeur et pourcentage d'utilisation maximale du tampon de trace

  • value number
  • percentage number

Récupère l'utilisation maximale sur les processus de mémoire tampon trace en pourcentage de l'état complet de .