crashReporter

Soumet des rapports de plantage à un serveur distant.

L'exemple suivant montre comment configurer Electron pour qu'il envoie automatiquement des rapports de plantage à un serveur distant :

const { crashReporter } = require('electron')

crashReporter.start({ submitURL: 'https://votre-domain.com/url-to-submit' })

Pour configurer un serveur afin qu'il accepte et traite les rapports de plantage, vous pouvez utiliser les projets suivants :

Note : Electron utilise Crashpad et non Breakpad pour collecter et enregistrer les crashs, mais pour le moment le protocole d'upload est le même .

Ou sinon vous pouvez utiliser une solution hébergée par un tiers :

Les rapports de plantage sont stockés temporairement avant d'être téléchargés dans un dossier du répertoire de données utilisateur de l'application, appelé 'Crashpad'. Vous pouvez modifier ce répertoire en appelant app.setPath('crashDumps', '/path/to/crashes') avant de démarrer le rapporteur de crash.

Electron utilise crashpad pour surveiller et signaler les plantages.

Méthodes

Le module crashReporter dispose des méthodes suivantes :

`crashReporter.start(options)`

Objet options
- submitURL string (facultatif) - URL à laquelle les rapports de plantage seront envoyés sous la forme de POST. Requis sauf si uploadToServer est false.
- productName string (facultatif) - app.name.
- companyName string (facultatif) Déprécié - Alias obsolète pour { globalExtra: { _companyName: ... } }.
- uploadToServer boolean (facultatif) - Indique si les rapports de crash doivent être envoyés au serveur. Si la valeur est false, les rapports de plantage seront collectés et stockés dans le répertoire de crash mais pas téléchargés. La valeur par défaut est true.
- ignoreSystemCrashHandler boolean (facultatif) - Si la valeur est true, les plantages générés dans le processus principal ne seront pas transférés au gestionnaire de plantage du système. Par défaut la valeur est false.
- rateLimit boolean (facultatif) macOS Windows - si la valeur est true, le nombre de plantages téléchargés sera limité à 1/heure. Par défaut la valeur est false.
- compress boolean (facultatif) - Si la valeur est true, les rapports de creash seront compressés et téléchargés avec Content-Encoding: gzip. La valeur par défaut est true.
- extra Record<string, string> (optional) - Extra string key/value annotations that will be sent along with crash reports that are generated in the main process. Seuls les variables de type string sont pris en charge. Les crash intervenant dans des processus enfants ne contiendront pas ces paramètres et dans ce cas il faut faire appel à addExtraParameter à partir du processus enfant.
- globalExtra Record<string, string> (optional) - Extra string key/value annotations that will be sent along with any crash reports generated in any process. Ces annotations ne peuvent pas être modifiées une fois que le crashreporter a été démarré. Si une clé est présente à la fois dans les paramètres supplémentaires globaux et dans les paramètres supplémentaires spécifiques au processus, alors la clé globale prendra la priorité. Par défaut, productName et la version de l'application sont incluses, comme la version d'Electron.

Cette méthode doit être appelée avant toute autre API de crashReporter. Une fois initialisé de cette façon, le gestionnaire de crash collectera les crash de tous les processus créés par la suite. Le rapporteur de crash ne peut pas être désactivé une fois démarré.

Cette méthode doit être appelée le plus tôt possible lors du démarrage de l'application et de préférence avant app.on('ready'). Si le rapporteur de plantage n'est pas encore initialisé au moment où un processus de rendu est créé, alors celui-ci ne sera pas surveillé en cas de crash.

Note: Vous pouvez tester le reporter de crash en produisant un crash généré par process.crash().

Note : si vous devez envoyer des paramètres extra supplémentaires/ou mis à jour après votre premier appel start vous pouvez appeler l addExtraParameter.

Note : Les paramètres passés dans extra, globalExtra ou fixés par addExtraParameter sont limités en longueur pour leurs clés et valeurs. Les noms de clés ne doivent pas dépasser 39 bytes de long, et les valeurs ne doivent pas dépasser 127 bytes . Les clés dont les noms sont plus longs que le maximum seront ignorées sans d'avantage d'information. Les valeurs elles, seront tronquées à la valeur maximale.