docs: add notes for environment variable LOGLEVEL

Signed-off-by: Xuehai Pan <[email protected]>
XuehaiPan · Jul 31, 2022 · 41f7325 · 41f7325
1 parent 603718f
commit 41f7325
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -4,7 +4,8 @@
 
   1. Was this issue already reported? Please do a quick search.
   2. Maybe the problem is solved in the current master branch already?
-     Simply clone nvitop's git repository and run ./nvitop.py to find out.
+     Simply clone nvitop's git repository and run `LOGLEVEL=DEBUG ./nvitop.py`
+     to find out.
   3. Provide all the relevant information, as outlined in this template.
      Feel free to remove any sections you don't need.
 -->

diff --git a/README.md b/README.md
@@ -310,7 +310,7 @@ process filtering:
                         Only show processes of the given PIDs.
 ```
 
-`nvitop` can accept the following environment variables for monitor mode:
+`nvitop` can accept the following environment variables:
 
 | Name                                   | Description                      | Valid Values                                                | Fallback Value |
 | -------------------------------------- | -------------------------------- | ----------------------------------------------------------- | -------------- |
@@ -319,6 +319,7 @@ process filtering:
 | `NVITOP_MONITOR_THEME`                 | The default color theme          | `dark` / `light`                                            | `dark`         |
 | `NVITOP_GPU_UTILIZATION_THRESHOLDS`    | Thresholds of GPU utilization    | `10,75` , `1,99`, ...                                       | `10,75`        |
 | `NVITOP_MEMORY_UTILIZATION_THRESHOLDS` | Thresholds of GPU memory percent | `10,80` , `1,99`, ...                                       | `10,80`        |
+| `LOGLEVEL`                             | Log level for log messages       | `DEBUG` , `INFO`, `WARNING`, ...                            | `WARNING`      |
 
 For example: