getstation / electron-process-manager Goto Github PK

Process manager UI for Electron applications

HTML 4.98% JavaScript 95.02%

electron-process-manager's Introduction

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..).

⚠️ For @electron>=3.0.0, <7.x, use version 0.7.1 of this package. For versions >=7.x, use latest.

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

It's inspired from Chrome's task manager.

Features

⚠️ Unfortunately, memory info are no longer available in Electron>=4 (see electron/electron#16179)

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

electron-process-manager's People

Contributors

Stargazers

Watchers

electron-process-manager's Issues

Memoize misspelled

const memoize = require("memoizee"); in src/ProcessStatsReporter.js

Missing electron peer dependency

We should add electron compatible version range in peerDependencies

"peerDependencies": { "electron": ">=1.7.1 <=2.02" }

Additionally it can be a good thing to add [email protected] in devDependencies to fix unit tests.

Window opens up blank in Electron 5.0

The problem is that nodeIntegration defaults to false in Electron 5.0. Setting nodeIntegration to true in the webPreferences option when constructing the ProcessManagerWindow (extending BrowserWindow) seems to rectify that problem.

Remove React Dependency

React+React-Dom is about 110 KB in size before compression.
Removing React and updating the UI manually will probably save 95-100 KB before compression.

Uncaught (in promise) TypeError: Class extends value undefined is not a constructor or null

Hi. Just started using this with the latest electron nightly build, and got this error in console
Uncaught (in promise) TypeError: Class extends value undefined is not a constructor or null

Electron tray can't show

When I require this module and use Tray, tray only show Flashing then hide.

I followed the problem and found that electron-process-reporter read rxjs cause this problem.

Do you have any other suggestions?

Thanks.

Problem with electron-packager

Since commit 31f8b87 (maybe the problem is more in electron-process-manager), application using process-manager crash when they are packaged with electron-packager.
I don't find why but will check later.

bug: can't work with vue-cli-plugin-electron

i m use vue-cli create project, and add vue-cli-plugin-electron-builder, this my code up

app.on('ready', async () => {
  if (isDevelopment && !process.env.IS_TEST) {
    // Install Vue Devtools
    try {
      await installVueDevtools()
    } catch (e) {
      console.error('Vue Devtools failed to install:', e.toString())
    }
  }
  createWindow()
  openProcessManager()
})