OctoPrint日志配置详解：logging.yaml文件完全指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00312/article/details/148440151

OctoPrint日志配置详解：logging.yaml文件完全指南

OctoPrint OctoPrint is the snappy web interface for your 3D printer! 项目地址: https://gitcode.com/gh_mirrors/oc/OctoPrint

什么是logging.yaml文件

logging.yaml是OctoPrint用于控制日志记录行为的配置文件，它允许用户自定义日志级别、日志处理器和日志格式。通过合理配置这个文件，用户可以更有效地监控OctoPrint运行状态，排查问题，以及优化日志存储方式。

文件位置

根据操作系统不同，logging.yaml文件默认位于以下位置：

Linux: ~/.octoprint/logging.yaml
Windows: %APPDATA%/OctoPrint/logging.yaml
macOS: ~/Library/Application Support/OctoPrint/logging.yaml

修改日志级别

基本语法结构

要修改特定组件的日志级别，使用以下YAML格式：

loggers:
  <组件名称>:
    level: <日志级别>

其中：

<组件名称>：OctoPrint内部组件标识符
<日志级别>：可以是DEBUG、INFO、WARNING、ERROR或CRITICAL

常用组件列表

以下是一些重要的可配置组件及其作用：

octoprint.events：事件子系统，记录所有事件处理
octoprint.filemanager：文件管理模块，处理SD卡和本地文件操作
octoprint.plugin：插件系统核心功能
octoprint.plugins. ：特定插件日志，如octoprint.plugins.discovery
octoprint.slicing：切片功能相关日志

配置示例

loggers:
  octoprint.events:
    level: DEBUG
  octoprint.filemanager:
    level: DEBUG
  octoprint.plugins.discovery:
    level: INFO

配置日志处理器

OctoPrint默认使用三种日志处理器：

console：控制台输出处理器
file：主日志文件处理器(octoprint.log)
serialFile：串口通信日志处理器(serial.log)

默认配置解析

handlers:
  # 控制台输出
  console:
    class: logging.StreamHandler  # 处理器类
    level: DEBUG                 # 记录级别
    formatter: colored           # 使用彩色格式
    stream: ext://sys.stdout     # 输出到标准输出

  # 主日志文件
  file:
    class: logging.handlers.TimedRotatingFileHandler  # 按时间滚动
    level: DEBUG
    formatter: simple
    when: D                      # 每天滚动
    backupCount: 1               # 保留1个备份
    filename: /path/to/logs/octoprint.log

  # 串口日志文件
  serialFile:
    class: logging.handlers.RotatingFileHandler  # 按大小滚动
    level: DEBUG
    formatter: simple
    maxBytes: 2097152            # 2MB后滚动(2*1024*1024)
    filename: /path/to/logs/serial.log

自定义配置建议

增大串口日志大小：调试长时间通信时，可增加maxBytes值
修改滚动策略：可将file处理器改为按大小滚动
增加备份数量：修改backupCount保留更多历史日志

自定义日志格式

OctoPrint提供两种默认日志格式：

simple：基础文本格式
colored：带颜色标记的格式(控制台使用)

默认格式定义

formatters:
  simple:
    format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
  colored:
    format: "%(log_color)s%(asctime)s - %(name)s - %(levelname)s - %(message)s%(reset)s"

高级格式定制

可以添加更多LogRecord属性来丰富日志信息，例如包含文件名和行号：

formatters:
  simple:
    format: "%(asctime)s - %(name)s - %(pathname)s%(filename)s#%(lineno)d - %(levelname)s - %(message)s"
  colored:
    format: "%(log_color)s%(asctime)s - %(name)s - %(pathname)s%(filename)s#%(lineno)d - %(levelname)s - %(message)s%(reset)s"