Skip to content

Use pss if available #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 28, 2023
Merged

Use pss if available #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a92cf21
Use `pss` if available
jtpio Jan 23, 2023
3f50379
Add small note in README.md
jtpio Jan 27, 2023
52fa6e1
Use the Nullish coalescing operator
jtpio Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,9 @@ causes "lag"/pauses in the UI. To workaround this you can disable Prometheus met

## Resources Displayed

Currently the server extension only reports memory usage (just RSS) and CPU usage. Other metrics will be
added in the future as needed.
Currently the server extension only reports memory usage and CPU usage. Other metrics will be added in the future as needed.

Memory usage will show the PSS whenever possible (Linux only feature), and default to RSS otherwise.

The notebook extension currently doesn't show CPU usage, only memory usage.

Expand Down
12 changes: 9 additions & 3 deletions jupyter_resource_usage/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,30 @@ async def get(self):

# Get memory information
rss = 0
pss = None
for p in all_processes:
try:
rss += p.memory_info().rss
info = p.memory_full_info()
if hasattr(info, "pss"):
pss = (pss or 0) + info.pss
rss += info.rss
except (psutil.NoSuchProcess, psutil.AccessDenied) as e:
pass

if callable(config.mem_limit):
mem_limit = config.mem_limit(rss=rss)
mem_limit = config.mem_limit(rss=rss, pss=pss)
else: # mem_limit is an Int
mem_limit = config.mem_limit

limits = {"memory": {"rss": mem_limit}}
limits = {"memory": {"rss": mem_limit, "pss": mem_limit}}
if config.mem_limit and config.mem_warning_threshold != 0:
limits["memory"]["warn"] = (mem_limit - rss) < (
mem_limit * config.mem_warning_threshold
)

metrics = {"rss": rss, "limits": limits}
if pss is not None:
metrics["pss"] = pss

# Optionally get CPU information
if config.track_cpu_percent:
Expand Down
8 changes: 5 additions & 3 deletions jupyter_resource_usage/static/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,16 @@ define([
$.getJSON({
url: utils.get_body_data('baseUrl') + 'api/metrics/v1',
success: function (data) {
totalMemoryUsage = humanFileSize(data['rss']);
value = data['pss'] || data['rss'];
totalMemoryUsage = humanFileSize(value);

var limits = data['limits'];
var display = totalMemoryUsage;

if (limits['memory']) {
if (limits['memory']['rss']) {
maxMemoryUsage = humanFileSize(limits['memory']['rss']);
limit = limits['memory']['pss'] ?? limits['memory']['rss'];
if (limit) {
maxMemoryUsage = humanFileSize(limit);
display += " / " + maxMemoryUsage
}
if (limits['memory']['warn']) {
Expand Down
9 changes: 5 additions & 4 deletions packages/labextension/src/memoryUsage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,9 @@ export namespace MemoryUsage {
this._units = 'B';
this._warn = false;
} else {
const numBytes = value.rss;
const memoryLimit = value.limits.memory
? value.limits.memory.rss
: null;
const numBytes = value.pss ?? value.rss;
const memoryLimits = value.limits.memory;
const memoryLimit = memoryLimits?.pss ?? memoryLimits?.rss ?? null;
const [currentMemory, units] = convertToLargestUnit(numBytes);
const usageWarning = value.limits.memory
? value.limits.memory.warn
Expand Down Expand Up @@ -260,9 +259,11 @@ namespace Private {
*/
export interface IMetricRequestResult {
rss: number;
pss?: number;
limits: {
memory?: {
rss: number;
pss?: number;
warn: boolean;
};
};
Expand Down