general/occlum
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[readthedocs] Description for Occlum log config option

Browse Source
This commit is contained in:
Qi Zheng 2023-08-29 16:26:57 +08:00 committed by volcano
parent a7317b0aa9
commit bc7096815d
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/readthedocs/docs/source/how_to_debug.md
View File

@ -4,4 +4,6 @@ To debug an app running upon Occlum, one can harness Occlum's builtin support fo
Meanwhile, one can use `occlum mount` command to access and manipulate the secure filesystem for debug purpose. Meanwhile, one can use `occlum mount` command to access and manipulate the secure filesystem for debug purpose.
If the cause of a problem does not seem to be the app but Occlum itself, then one can take a glimpse into the inner workings of Occlum by checking out its log. Occlum's log level can be adjusted through `OCCLUM_LOG_LEVEL` environment variable. It has six levels: `off`, `error`, `warn`, `debug`, `info`, and `trace`. The default value is `off`, i.e., showing no log messages at all. The most verbose level is `trace`. If the cause of a problem does not seem to be the app but Occlum itself, then one can take a glimpse into the inner workings of Occlum by checking out its log. Occlum's log level can be adjusted through `OCCLUM_LOG_LEVEL` environment variable. It has six levels: `off`, `error`, `warn`, `debug`, `info`, and `trace`. The default value is `off`, i.e., showing no log messages at all. The most verbose level is `trace`.
The Occlum log output could be disabled totally for better security by setting `metadata.disable_log=true` in `Occlum.json` before building the Occlum instance. For detail please refer [Occlum Configuration](https://occlum.readthedocs.io/en/latest/occlum_configuration.html).

9
docs/readthedocs/docs/source/occlum_configuration.md
View File

@ -61,7 +61,14 @@ The template of `Occlum.json` is shown below.
"version_number": 0, "version_number": 0,
// Whether the enclave is debuggable through special SGX instructions. // Whether the enclave is debuggable through special SGX instructions.
// For production enclave, it is IMPORTANT to set this value to false. // For production enclave, it is IMPORTANT to set this value to false.
"debuggable": true "debuggable": true,
// Whether the enclave is allowable to print Occlum log.
// Optional, if not set, in default it is false for debuggable enclave
// but true for production/release enclave for better security.
// Production/release enclave could explicitly set it false to have log
// output for debugging purpose. In this case, error log level is the
// only allowed log level.
"disable_log": false,
}, },
// Features // Features
"feature": { "feature": {