erickzhao

#53337: docs: clarify CPUUsage window

Merged
Created: Aug 31, 2026, 12:24:18 PM
Merged: Sep 1, 2026, 6:22:53 PM
4 comments
Target: main

Description of Change

I stumbled upon this with an internal report that Sentry's Electron SDK was actually resetting the window from our own internal app.getAppMetrics() calls.

This info was buried deep in the CPUUsage.md structure doc, and not immediately discenerable from the API docs themselves.

This PR does a few things:

  • Adds more detail on how the measurement intervals work in CPUUsage.md.
  • Adds a brief note on using cumulatedCPUUsage to calculate CPU usage in a given window.
  • Adds notes to process.getCPUUsage and app.getAppMetrics linking to CPUUsage.md.

cc @electron/docs

Checklist

Release Notes

Notes: none

Backports

43-x-y
Merged
PR Number
#53385
Merged At
Sep 1, 2026, 9:08:35 PM
Released In
Not yet
Release Date
Not yet
44-x-y
Merged
PR Number
#53386
Merged At
Sep 1, 2026, 9:08:33 PM
Released In
Not yet
Release Date
Not yet
45-x-y
Merged
PR Number
#53384
Merged At
Sep 1, 2026, 11:50:52 PM
Released In
Not yet
Release Date
Not yet

Semver Impact

Major
Breaking changes
Minor
New features
Patch
Bug fixes
None
Docs, tests, etc.

Semantic Versioning helps users understand the impact of updates:

  • Major (X.y.z): Breaking changes that may require code modifications
  • Minor (x.Y.z): New features that maintain backward compatibility
  • Patch (x.y.Z): Bug fixes that don't change the API
  • None: Changes that don't affect using facing parts of Electron