Process manager UI for Electron applications
Clone or download
Latest commit de166ad Sep 11, 2018

README.md

Process Manager UI for Electron Apps

This package provides a process manager UI for Electron applications.

It opens a window displaying a table of every processes run by the Electron application with information (type, URL for webContents, memory..).

npm version

screenshot

⚠️ For @electron>=1.7.1 and @electron<3.0.0

It can be useful to debug performance of an app with several webview.

It's inspired from Chrome's task manager.

Features

  • Memory reporting
  • Link memory data to web-contents (for electron >=1.7.1)
  • Kill a process from the UI
  • Open developer tools for a given process
  • CPU metrics
  • Sort by columns

Installation

$ npm install electron-process-manager

Usage

const { openProcessManager } = require('electron-process-manager');

openProcessManager();

Options

openProcessManager function can take options in paramters

options.defaultSorting

defaultSorting.how: 'ascending' | 'descending'

defaultSorting.path:

Field name path
Pid 'pid'
WebContents Domain 'webContents.0.URLDomain'
Process Type 'webContents.0.type'
Private Memory 'memory.privateBytes'
Shared Memory 'memory.sharedBytes'
Working Set Size 'memory.workingSetSize'
% CPU 'cpu.percentCPUUsage'
Idle Wake Ups /s 'cpu.idleWakeupsPerSecond'
WebContents Id 'webContents.0.id'
WebContents Type 'webContents.0.type'
WebContents URL 'webContents.0.URL'

example:

const { openProcessManager } = require('electron-process-manager');

openProcessManager({ how: 'descending', path: 'cpu.percentCPUUsage' });

Future

  • Add physical memory (noted as "Memory" in Chrome's task manager)
  • Add networks metrics

Pull requests welcome :)

License

MIT License