From 0cbb9b5ba7479693a62590b7bbb44cd32c4382f1 Mon Sep 17 00:00:00 2001 From: Self Denial Date: Mon, 1 Apr 2024 17:21:15 -0600 Subject: [PATCH] Small update to add new enviornment variables. See open-webui/#1370 --- docs/getting-started/logging.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/logging.md b/docs/getting-started/logging.md index 6ade520..d75d9e9 100644 --- a/docs/getting-started/logging.md +++ b/docs/getting-started/logging.md @@ -13,7 +13,7 @@ Client logging generally occurs via [JavaScript](https://developer.mozilla.org/e ## Application Server/Backend Logging ## -Logging is an ongoing work-in-progress but some level of control is available using environment variables. [Python Logging](https://docs.python.org/3/howto/logging.html) `log()` and `print()` statements send information to the console. The default level is `INFO`. +Logging is an ongoing work-in-progress but some level of control is available using environment variables. [Python Logging](https://docs.python.org/3/howto/logging.html) `log()` and `print()` statements send information to the console. The default level is `INFO`. Ideally, sensitive data will only be exposed with `DEBUG` level. ### Logging Levels ### @@ -33,9 +33,9 @@ The following [logging levels](https://docs.python.org/3/howto/logging.html#logg The default global log level of `INFO` can be overridden with the `GLOBAL_LOG_LEVEL` environment variable. When set, this executes a [basicConfig](https://docs.python.org/3/library/logging.html#logging.basicConfig) statement with the `force` argument set to *True* within `config.py`. This results in reconfiguration of all attached loggers: > _If this keyword argument is specified as true, any existing handlers attached to the root logger are removed and closed, before carrying out the configuration as specified by the other arguments._ -In addition to all Open-WebUI `log()` statements, this also affects any imported Python modules that use the Python Logging module `basicConfig` mechanism including [urllib](https://docs.python.org/3/library/urllib.html). +The stream uses standard output (`sys.stdout`). In addition to all Open-WebUI `log()` statements, this also affects any imported Python modules that use the Python Logging module `basicConfig` mechanism including [urllib](https://docs.python.org/3/library/urllib.html). -For example, set `DEBUG` logging level as a Docker parameter: +For example, to set `DEBUG` logging level as a Docker parameter use: ``` --env GLOBAL_LOG_LEVEL="DEBUG" ``` @@ -46,7 +46,8 @@ Some level of granularity is possible using any of the following combination of | Environment Variable | App/Backend | | -------------------- | ----------------------------------------------------------------- | -| `AUDIO_LOG_LEVEL` | Audio transcription, etc. | +| `AUDIO_LOG_LEVEL` | Audio transcription using faster-whisper, TTS etc. | +| `COMFYUI_LOG_LEVEL` | ComfyUI integration handling | | `CONFIG_LOG_LEVEL` | Configuration handling | | `DB_LOG_LEVEL` | Internal Peewee Database | | `IMAGES_LOG_LEVEL` | AUTOMATIC1111 stable diffusion image generation | @@ -56,3 +57,4 @@ Some level of granularity is possible using any of the following combination of | `OLLAMA_LOG_LEVEL` | Ollama backend interaction | | `OPENAI_LOG_LEVEL` | OpenAI interaction | | `RAG_LOG_LEVEL` | Retrieval-Augmented Generation using Chroma/Sentence-Transformers | +| `WEBHOOK_LOG_LEVEL` | Authentication webhook extended logging |