全局日志系统

CSM全局日志系统是框架内置的调试和监控机制，记录系统运行时的各类事件，帮你快速了解模块交互、状态变化和错误信息。

功能概述

全局日志可以记录这些信息：

  • 模块状态修改: 每个状态的执行和参数
  • 模块间消息: 同步/异步消息和返回数据
  • 状态发布: 广播事件的发送
  • 模块生命周期: 创建和销毁
  • 状态订阅: 订阅关系的建立和取消
  • 错误信息: 各类错误事件
  • 用户自定义事件: 你自己添加的日志

基于日志功能可以开发各种调试工具，比如日志窗口、状态仪表板等。

获取日志的两种方式

队列方式（推荐）

队列方式效率更高，可以批量处理日志，性能最好。使用步骤：

  1. 用CSM - Global Log Queue.vi获取队列句柄
  2. 在循环中用Dequeue Element获取日志
  3. 处理日志数据
  4. 用CSM - Destroy Global Log Queue.vi释放资源

事件方式

通过LabVIEW用户事件机制接收日志，适合和UI事件一起处理的场景：

  1. 用CSM - Global Log Event.vi获取事件句柄
  2. 在事件结构中注册并处理
  3. 用CSM - Destroy Global Log Event.vi释放资源

怎么选？ 独立处理日志用队列方式，要和UI事件混合处理用事件方式。

日志过滤

为了减轻系统负担和提高日志可读性，CSM提供了完善的过滤机制。

源端过滤 vs 订阅端过滤

源端过滤（在CSM框架层设置）：

  • 优点：日志源头就不产生，减轻系统负担，对所有订阅者生效
  • 缺点：全局生效，影响所有工具
  • 适用：确定某些日志都不需要，生产环境屏蔽调试日志

订阅端过滤（接收后再判断）：

  • 优点：只影响当前订阅者，灵活性高，可动态调整
  • 缺点：日志已产生，系统负担未减轻
  • 适用：不同工具需要不同日志，开发调试阶段

过滤规则类型

1. 全局规则（针对所有模块）

  • 模块名称过滤: 过滤指定模块的所有日志（如”.Logger”模块）
  • 日志类型过滤: 过滤特定类型（状态、消息、广播、模块初始化等）
  • 状态名称过滤: 过滤任意模块的特定状态（如所有”Idle”状态）
  • 状态类型过滤: 按状态类型过滤（内部状态、外部消息等）

2. 模块规则（针对特定模块）

  • 模块的日志类型: 过滤指定模块的特定日志类型（如”UIModule”的”广播”日志）
  • 状态名称: 过滤指定模块的特定状态（如”DataAcq”模块的”Read Data”状态）
  • 状态类型: 过滤指定模块的特定状态类型（如”Controller”模块的”外部消息”）

3. 周期过滤规则（仅订阅端，针对高频日志）

  • Threshold (#/s): 单位时间内超过此数量视为高频
  • CheckPeriod (s): 检查窗口时间
  • 示例：10秒内出现超过100次的”Data Updated”状态，折叠显示

过滤相关API

自定义日志

除了框架自动记录的事件，你也可以手动生成日志：

CSM - Generate User Global Log.vi

生成自定义用户日志，适用于记录业务逻辑节点、性能测量点、用户操作等。

输入: Log（事件名称）、Arguments（参数）、From Who（来源）、ModuleName（模块名称）、Place（发生地点）

注意: 输入参数包含错误信息时，会自动调用CSM - Global Log Error Handler.vi。

CSM - Global Log Error Handler.vi

将非CSM框架的错误统一记录到全局日志，便于集成第三方库或LabVIEW原生错误。

输入: Place（错误位置，默认用调用VI的名称）、Clear Error?（是否清除错误，默认True）

工具函数

日志转换

日志处理

Global Log History Cacher.vi

缓存历史日志字符串，支持限制缓存长度、周期性日志折叠和多级处理等级。

主要输入: Global Log Data、Length（最大缓存长度，默认10000）、Level（处理等级，更高等级省略信息以提高速度）、Settings（周期性日志配置）

Auto Processing Level.vi

根据队列长度变化速度动态推荐处理等级：正常时用Normal等级显示完整信息，日志堆积时提升等级加快处理，稳定后自动降级。

主要输入: #Left In Q（队列剩余数量）、Debounce Period（5s）、Period（0.1s）

Exit With Empty Queue Check.vi

日志监控循环的优雅退出：Stop信号到来时不立即退出，继续处理队列中的剩余日志，队列为空或超时后才真正退出。

主要输入: Queue、Stop、Timeout（5s）

典型应用场景

  • 调试工具开发: 实时日志窗口、状态仪表板、消息流图等
  • 问题诊断: 错误追踪、时序分析、死锁检测等
  • 性能监控: 消息统计、瓶颈识别、处理时间分析等
  • 日志记录: 操作历史、审计追踪、故障分析等

最佳实践

  • 开发阶段保留更多日志，生产环境用源端过滤减轻系统负担
  • 高频日志使用周期过滤规则
  • 优先使用队列方式获取日志，根据堆积情况动态调整处理等级
  • 避免在日志处理或高频循环中执行耗时操作
  • 在关键业务节点添加自定义日志，使用清晰的名称和参数
  • 开发日志工具时注意性能和资源占用，支持搜索、筛选和导出功能

参考范例

CSM提供了多个使用范例：

  • 4. Advance Examples\Filter From Source(Queue).vi - 源端过滤（队列）
  • 4. Advance Examples\Filter From Source(Event).vi - 源端过滤（事件）
  • 4. Advance Examples\Filter From Subscriber(Queue).vi - 订阅端过滤（队列）
  • 4. Advance Examples\Filter From Subscriber(Event).vi - 订阅端过滤（事件）
  • CSM - Global Log Queue Monitoring Loop.vi - 队列监控模板
  • CSM - Global Log Event Monitoring Loop.vi - 事件监控模板

总结

CSM全局日志系统为调试、监控和问题诊断提供了完整支持，合理使用可大幅提高开发效率。