Electron Application Integration¶
Electron page data is collected by the Browser SDK in the Renderer and can be reported independently or passed to the native SDK via the Native Bridge.
Choose an Integration Method¶
- Browser Standalone Reporting: Only page monitoring is required. The Browser SDK manages the Session and upload. See Browser Standalone Integration.
- Native Bridge: Requires the native SDK to manage Session, sampling, context, and upload uniformly. Continue with the integration modes below.
Only one method can be used per page; initialization configurations from the two methods cannot be mixed.
Choose a Native Bridge Mode¶
| Mode | Use Cases | Integration Documentation |
|---|---|---|
Full mode (managed) |
The application itself is Electron; the Adapter initializes and shuts down the Native SDK | Quick Start |
Mixed mode (external) |
The native host has already integrated the Native SDK, and Electron connects to an existing instance | Windows Host, macOS Host |
Only one mode can be used per Electron process. Both modes share Preload, Window, and Renderer Configuration.
Supported Scope and Versions¶
The Native Adapter supports Windows (x64, x86 / ia32, arm64) and macOS (x64, arm64). Linux is not supported. The Electron compatibility range is ^22.3.27 || 43.x; intermediate major versions have not been verified.
The Adapter, Browser SDK, and Native SDK maintain separate versions; the matching Native SDK version is determined by the installed Adapter's package.json.nativeRuntime.
For OS requirements, runtime installation, and packaging methods, see Windows Platform Notes and macOS Platform Notes.