Skip to main content

理解 Open WebUI 日志记录 🪵

日志记录对于调试、监控和理解 Open WebUI 的行为至关重要。本指南解释了日志记录在浏览器客户端（前端）和应用服务器/后端中的工作方式。

🖥️ 浏览器客户端日志记录（前端）​

对于前端开发和调试，Open WebUI 使用标准的浏览器控制台日志记录。这意味着您可以直接在网络浏览器的内置开发者工具中查看日志。

如何访问浏览器日志：

  1. 打开开发者工具： 在大多数浏览器中，您可以通过以下方式打开开发者工具：

    • 在 Open WebUI 页面的任何地方右键单击并选择"检查"或"检查元素"。
    • 按 F12（或在 macOS 上按 Cmd+Opt+I）。

  2. 导航到"控制台"选项卡： 在开发者工具面板中，找到并点击"控制台"选项卡。

浏览器日志的类型：

Open WebUI 主要使用 JavaScript 的 console.log() 进行客户端日志记录。您将在控制台中看到各种类型的消息，包括：

  • 信息消息： 一般应用程序流程和状态。
  • 警告： 潜在问题或非关键错误。
  • 错误： 可能影响功能的问题。

特定浏览器的开发者工具：

不同浏览器提供略有不同的开发者工具，但它们都提供查看 JavaScript 日志的控制台。以下是流行浏览器的文档链接：

⚙️ 应用服务器/后端日志记录（Python）​

Open WebUI 的后端使用 Python 的内置 logging 模块在服务器端记录事件和信息。这些日志对于理解服务器行为、诊断错误和监控性能至关重要。

关键概念：

  • Python logging 模块： Open WebUI 利用标准的 Python logging 库。如果您熟悉 Python 日志记录，您会发现这一部分很简单。（有关更深入的信息，请参见 Python 日志记录文档）。
  • 控制台输出： 默认情况下，后端日志发送到控制台（标准输出），使它们在您的终端或 Docker 容器日志中可见。
  • 日志级别： 日志级别控制日志的详细程度。您可以配置 Open WebUI 根据这些级别显示更多或更少的详细信息。

🚦 日志级别解释​

Python 日志记录使用级别层次结构按严重性对日志消息进行分类。以下是从最严重到最不严重的级别分解：

级别数值描述用例
CRITICAL50严重错误，可能导致应用程序终止。灾难性故障、数据损坏。
ERROR40错误，表示问题但应用程序可能仍能运行。可恢复的错误、失败的操作。
WARNING30潜在问题或应该调查的意外情况。弃用警告、资源约束。
INFO20关于应用程序操作的一般信息消息。启动消息、关键事件、正常操作流程。
DEBUG10开发者的详细调试信息。函数调用、变量值、详细执行步骤。
NOTSET0记录所有消息。（如果未设置，通常默认为 WARNING）。用于捕获绝对所有内容，通常用于非常特定的调试。

默认级别： Open WebUI 的默认日志级别是 INFO。

🌍 全局日志级别（GLOBAL_LOG_LEVEL）​

您可以使用 GLOBAL_LOG_LEVEL 环境变量更改整个 Open WebUI 后端的全局日志级别。这是控制整体日志详细程度的最直接方法。

工作原理：

设置 GLOBAL_LOG_LEVEL 配置 Python 中的根记录器，影响 Open WebUI 中的所有记录器以及一些使用 basicConfig 的第三方库。它使用 logging.basicConfig(force=True)，这意味着它将覆盖任何现有的根记录器配置。

示例：设置为 DEBUG

  • Docker 参数：

    --env GLOBAL_LOG_LEVEL="DEBUG"

  • Docker Compose (docker-compose.yml)：

    environment:
      - GLOBAL_LOG_LEVEL=DEBUG

影响： 将 GLOBAL_LOG_LEVEL 设置为 DEBUG 将产生最详细的日志，包括对开发和故障排除有用的详细信息。对于生产环境，INFO 或 WARNING 可能更合适以减少日志量。

⚙️ 应用/后端特定日志级别​

为了更精细的控制，Open WebUI 提供环境变量来为特定后端组件设置日志级别。日志记录是一项正在进行的工作，但使用这些环境变量可以提供一定程度的控制。这些变量允许您微调应用程序不同部分的日志记录。

可用的环境变量：

环境变量组件/模块描述
AUDIO_LOG_LEVEL音频处理与音频转录（faster-whisper）、文本转语音（TTS）和音频处理相关的日志记录。
COMFYUI_LOG_LEVELComfyUI 集成如果您使用此集成，则与 ComfyUI 交互的日志记录。
CONFIG_LOG_LEVEL配置管理与加载和处理 Open WebUI 配置文件相关的日志记录。
DB_LOG_LEVEL数据库操作（Peewee）使用 Peewee ORM（对象关系映射器）进行数据库交互的日志记录。
IMAGES_LOG_LEVEL图像生成（AUTOMATIC1111/Stable Diffusion）图像生成任务的日志记录，特别是使用 AUTOMATIC1111 Stable Diffusion 集成时。
MAIN_LOG_LEVEL主应用程序执行（根记录器）来自主应用程序入口点和根记录器的日志记录。
MODELS_LOG_LEVEL模型管理与加载、管理和与语言模型（LLM）交互相关的日志记录，包括身份验证。
OLLAMA_LOG_LEVELOllama 后端集成与 Ollama 后端通信和交互的日志记录。
OPENAI_LOG_LEVELOpenAI API 集成与 OpenAI API 交互的日志记录（例如，用于 GPT 等模型）。
RAG_LOG_LEVEL检索增强生成（RAG）RAG 管道的日志记录，包括 Chroma 向量数据库和 Sentence-Transformers。
WEBHOOK_LOG_LEVEL身份验证 Webhook身份验证 webhook 功能的扩展日志记录。

如何使用：

您可以像设置 GLOBAL_LOG_LEVEL 一样设置这些环境变量（Docker 参数、Docker Compose environment 部分）。例如，要获得 Ollama 交互的更详细日志记录，您可以设置：

environment:
  - OLLAMA_LOG_LEVEL=DEBUG

重要说明： 与 GLOBAL_LOG_LEVEL 不同，这些应用特定变量可能不会影响所有第三方模块的日志记录。它们主要控制 Open WebUI 代码库内的日志记录。

通过理解和利用这些日志记录机制，您可以有效地监控、调试和深入了解您的 Open WebUI 实例。