Day 3 - 日志、指标与诊断包
建议用时:150-210 分钟
你将学会什么
- 结构化记录关键日志
- 暴露健康指标
- 一键导出脱敏诊断包
现场报错时拿不到调试器。诊断包必须包含版本、配置摘要、日志、系统信息和通信统计,但不能泄漏密码。 今天的 3 个例子都要亲手敲,不能只复制,也不能只看运行结果。
标为 Program.cs 的最小例子可以放进控制台练习项目;标为 Service、ViewModel、XAML 或 SQL 文件的例子,要在本周项目中按前一天已经建立的模型继续敲。文件名和上下文不同,不要把所有片段塞进同一个 Program.cs。
学习衔接
这是 Week 21 的第 3 天。先使用前面已经掌握的 C#、异步、异常、接口和 MVVM,只增加今天这一层上位机能力。
今天的最低通过线
| 顺序 | 必须掌握 | 怎么证明 |
|---|---|---|
| 1 | 结构化记录关键日志 | 能用自己的话解释并完成对应例子 |
| 2 | 暴露健康指标 | 能用自己的话解释并完成对应例子 |
| 3 | 一键导出脱敏诊断包 | 能用自己的话解释并完成对应例子 |
先用大白话理解
现场报错时拿不到调试器。诊断包必须包含版本、配置摘要、日志、系统信息和通信统计,但不能泄漏密码。
学习时固定按这个顺序:
先看数据是什么
-> 再看最小代码
-> 对照运行结果
-> 修改一个参数
-> 故意制造错误
-> 最后组合进上位机项目例子 1:结构化通信错误
文件:Program.cs
logger.LogWarning(ex,
"设备读取失败 Device={DeviceId} Driver={Driver} Attempt={Attempt}",
device.Id, device.Driver, attempt);运行结果或界面效果:
日志字段可搜索和统计必须改一次: 不要记录密码和完整密钥。
例子 2:健康快照
文件:Program.cs
public record HealthSnapshot(
string Version, TimeSpan Uptime, int OnlineDevices,
int OfflineDevices, long DroppedSamples, int QueueLength);运行结果或界面效果:
诊断页显示版本、运行时间和采集健康必须改一次: 增加数据库大小和磁盘剩余。
例子 3:诊断包目录
文件:diagnostic-package.txt
diagnostics-20260713/
app-info.json
health.json
config-redacted.json
logs/
database-statistics.txt运行结果或界面效果:
诊断信息集中且配置已脱敏必须改一次: 压缩前扫描 Password、Token、ApiKey。
常见错误和修法
- 日志只有“失败了”没有设备和动作
- 诊断包包含明文密码
- 磁盘写满前没有指标和预警
修错顺序固定为:先看第一条异常和行号,再看输入数据,再看原始字节或状态,最后才怀疑框架。
小白重复敲写训练
- 不看上面的代码,重新敲“结构化通信错误”。
- 不看上面的代码,重新敲“健康快照”。
- 不看上面的代码,重新敲“诊断包目录”。
- 完成改动任务:不要记录密码和完整密钥。
- 完成改动任务:增加数据库大小和磁盘剩余。
- 完成改动任务:压缩前扫描 Password、Token、ApiKey。
每日小测
- 今天的知识在上位机里解决什么问题?
- 三个例子分别输入了什么,输出了什么?
- 如果运行结果不对,你第一步检查什么?
- 哪一段代码负责停止、超时或错误处理?
小测答案
答案不能只背一句话。回到三个例子,用代码中的变量、方法和输出逐项说明。能脱离页面说清楚,才算真的理解。
今日作业
- 新建空项目,不复制地重做三个例子。
- 每个例子都完成“必须改一次”。
- 故意制造一个错误,记录错误文字和修复办法。
- 把今天代码提交到自己的练习仓库。
作业验收
- 三个例子都能运行或显示预期界面。
- 能解释关键数据从哪里来、经过什么处理、最后去哪里。
- 失败时不会让程序无提示崩溃。
- 能说出今天内容如何进入“完整工业监控上位机毕业项目”。