日志查看器使用说明.md 3.2 KB

日志查看器使用说明

概述

日志查看器是一个实时显示应用程序日志信息的界面模块,集成在主应用程序的第三个标签页中。它提供了丰富的日志过滤、显示和管理功能。

功能特性

1. 实时日志显示

  • 实时接收并显示应用程序产生的所有日志信息
  • 支持不同日志级别的彩色显示:
    • DEBUG: 灰色
    • INFO: 黑色
    • WARNING: 橙色
    • ERROR: 红色
    • CRITICAL: 深红色

2. 日志级别过滤

  • 支持按日志级别进行过滤显示
  • 可以通过复选框选择要显示的日志级别
  • 支持多级别同时显示

3. 显示设置

  • 最大显示行数: 可设置最大显示的日志行数(100-10000行),超出部分自动删除旧日志
  • 自动滚动: 可开启/关闭自动滚动到最新日志功能

4. 日志管理功能

  • 清空日志: 清空当前显示的所有日志内容
  • 保存日志: 将当前显示的日志保存到文本文件
  • 测试日志: 发送各种级别的测试日志消息

5. 状态信息

  • 显示日志系统连接状态
  • 实时显示当前日志条数
  • 显示操作状态反馈

使用方法

1. 启动应用程序

python application.py

2. 切换到日志查看器标签页

在主应用程序窗口中,点击"日志查看器"标签页即可进入日志查看界面。

3. 配置显示选项

  • 日志级别过滤: 在控制面板的第一行,勾选或取消勾选相应的日志级别复选框
  • 最大显示行数: 在控制面板的第二行,调整数值输入框的值
  • 自动滚动: 勾选或取消勾选"自动滚动"复选框

4. 管理日志

  • 清空日志: 点击"清空日志"按钮清除当前显示的所有日志
  • 保存日志: 点击"保存日志"按钮将日志保存到文件
  • 测试日志: 点击"测试日志"按钮发送测试日志消息

技术实现

1. 日志信号机制

  • 通过自定义的LogHandler类实现日志信号发送
  • 使用PyQt6的信号槽机制实现实时日志传输
  • 支持多线程安全的日志处理

2. UI组件

  • 基于PyQt6实现的现代化界面
  • 使用QTextEdit组件显示日志内容
  • 支持富文本格式和颜色显示

3. 性能优化

  • 自动限制最大显示行数,避免内存溢出
  • 使用高效的文本光标操作进行日志插入
  • 支持大量日志的流畅显示

独立测试

可以使用提供的测试脚本独立测试日志查看器功能:

python test_log_viewer.py

该脚本会:

  1. 创建独立的日志查看器窗口
  2. 发送各种级别的测试日志
  3. 验证日志显示功能

注意事项

  1. 内存管理: 建议根据系统内存情况合理设置最大显示行数
  2. 性能考虑: 在高频日志输出场景下,可以适当调整日志级别过滤来减少显示负担
  3. 文件保存: 保存的日志文件采用UTF-8编码,确保中文字符正确显示
  4. 线程安全: 日志系统支持多线程环境,可以安全地从不同线程发送日志

扩展功能

未来可以考虑添加的功能:

  • 日志搜索和高亮显示
  • 日志导出为不同格式(JSON、CSV等)
  • 日志统计和分析功能
  • 远程日志接收功能
  • 日志告警和通知功能