crashReporter

クラッシュレポートをリモートサーバーに送信します。

以下は、Electron が外部サーバーにクラッシュレポートを自動送信するように設定する例です。

const { crashReporter } = require('electron')

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

クラッシュレポートを受信して処理するサーバーをセットアップするには、以下のプロジェクトを使用することができます。

注意: Electron はクラッシュの収集とアップロードに Breakpad ではなく Crashpad を使用していますが、当面はアップロードのプロトコルは同じです。

また、サードパーティによる解決方法も使用できます。

クラッシュリポートは、アップロードされる前にアプリのユーザーデータディレクトリ下にある「Crashpad」というディレクトリに一時保存されます。クラッシュリポーターを起動する前に app.setPath('crashDumps', '/path/to/crashes') を呼び出すことで、このディレクトリをオーバーライドできます。

Electron は crashpad を使用してクラッシュを監視し報告します。

メソッド

crashReporter モジュールには以下のメソッドがあります。

`crashReporter.start(options)`

options Object
- submitURL string (optional) - URL that crash reports will be sent to as POST. Required unless uploadToServer is false.
- productName string (任意) - 省略値は、app.name です。
- companyName string (任意) 非推奨 - { globalExtra: { _companyName: ... } } の非推奨な別名です。
- uploadToServer boolean (任意) - クラッシュレポートをサーバーに送信するかどうか。 false の場合、クラッシュレポートは収集されてクラッシュのディレクトリに保存されますが、アップロードされません。省略値は true です。
- ignoreSystemCrashHandler boolean (任意) - true の場合、メインプロセスで発生したクラッシュをシステムクラッシュハンドラに転送しません。省略値は false です。
- rateLimit boolean (任意) macOS Windows - true の場合、アップロードされるクラッシュの数を 1 時間につき 1 つに制限します。省略値は false です。
- compress boolean (任意) - true の場合、クラッシュレポートは圧縮され Content-Encoding: gzip でアップロードされます。省略値は true です。
- extra Record<string, string> (任意) - メインプロセスが生成するクラッシュレポートと一緒に送信される、追加のキー/バリューアノテーションの文字列。文字列のみをサポートしています。子プロセスから生成されたクラッシュレポートはこれらの追加パラメータを含みません。子プロセスが生成したクラッシュにこれらを含める場合は、子プロセスから addExtraParameter を呼び出してください。
- globalExtra Record<string, string> (任意) - 任意のプロセスが生成したクラッシュレポートと一緒に送信される、追加のキー/バリューアノテーションの文字列。これらのアノテーションは、クラッシュレポーターを起動すると変更できません。グローバル追加パラメータとプロセス固有の追加パラメータの両方に同じキーが存在する場合、グローバルのものが優先されます。デフォルトでは、 productName と、Electron のバージョンと同様のアプリのバージョンが含まれています。

このメソッドは、他の crashReporter API を使用する前に呼ばれなければなりません。このように初期化すると、crashpad ハンドラは、以降作成されたすべてのプロセスからクラッシュを収集します。一度起動したクラッシュリポーターは無効にできません。

このメソッドは、アプリの起動時にできるだけ早く、できれば app.on('ready') の前に呼び出す必要があります。レンダラープロセスの作成時にクラッシュリポーターが初期化されていない場合、そのレンダラープロセスはクラッシュリポーターに監視されません。

注: process.crash() でクラッシュを生成することで、クラッシュリポーターをテストできます。

注意: 最初の start 呼び出しの後に追加/更新された extra パラメータを送信する必要がある場合は、addExtraParameter を呼び出すことでできます。

注: extra、globalExtra で渡すパラメータや addExtraParameter で設定するパラメータは、キーと値の長さに制限があります。キー名の長さは最大 39 バイト、値の長さは 127 バイト以下でなければなりません。最大値より長い名前を持つキーは警告を出さずに無視されます。キーの値が最大長より長ければ切り捨てられます。