Skip to main content

了解 Open WebUI 日志记录 🪵

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

🖥️ 浏览器客户端日志记录 (前端)​

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

如何访问浏览器日志：

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

    • 在 Open WebUI 页面的任意位置 右键单击，然后选择“检查”或“检查元素”。
    • 按下 F12（或 macOS 上的 Cmd+Opt+I）。

  2. 导航到“控制台 (Console)”选项卡： 在开发人员工具面板中，找到并点击“控制台”选项卡。

浏览器日志类型：

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

  • 信息性消息 (Informational messages)： 常规应用程序流程和状态。
  • 警告 (Warnings)： 潜在问题或非关键错误。
  • 错误 (Errors)： 可能影响功能的问题。

浏览器特定的开发人员工具：

不同的浏览器提供略有不同的开发人员工具，但它们都提供了一个用于查看 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 实例。