Skip to content

Commit dd256e8

Browse files
pinksikrassowski
andauthored
Document show_host_usage configuration option in README (jupyter-server#218)
* updates readme with show_host_usage feature * Lint * Move the addition to the configuration section --------- Co-authored-by: Michał Krassowski <[email protected]>
1 parent bb960b8 commit dd256e8

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ The threshold for this warning can be configured as a fraction of the memory lim
103103
If you want to flash the warning to the user when they are within 10% of the memory limit, you
104104
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.
105105

106+
### Host information
107+
108+
If you want to hide host information from the Kernel Usage sidebar
109+
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information.
110+
The default is set as `True`, i.e. show all the information.
111+
112+
![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)
113+
106114
### CPU Usage
107115

108116
`jupyter-resource-usage` can also track CPU usage and report a `cpu_percent` value as part of the `/api/metrics/v1` response.

doc/kernel-usage-limited-info.png

20 KB
Loading

0 commit comments

Comments
 (0)