Skip to content

Commit

Permalink
Document show_host_usage configuration option in README (#218)
Browse files Browse the repository at this point in the history
* updates readme with show_host_usage feature

* Lint

* Move the addition to the configuration section

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
  • Loading branch information
pinksi and krassowski authored Aug 28, 2024
1 parent bb960b8 commit dd256e8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,14 @@ The threshold for this warning can be configured as a fraction of the memory lim
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.

### Host information

If you want to hide host information from the Kernel Usage sidebar
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information.
The default is set as `True`, i.e. show all the information.

![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)

### CPU Usage

`jupyter-resource-usage` can also track CPU usage and report a `cpu_percent` value as part of the `/api/metrics/v1` response.
Expand Down
Binary file added doc/kernel-usage-limited-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dd256e8

Please sign in to comment.