命令行与文本处理 / 系统课时
自动化脚本为什么必须留日志
自动化脚本为什么必须留日志
定时任务、备份和批处理脚本往往在无人值守的环境里运行,失败时没有终端观察者。日志的价值不是“多打印几行文字”,而是留下任务是否启动、执行到哪一步、为何失败以及何时结束的证据,让问题能够被复现和定位。
学习目标
- 理解无人值守脚本为什么必须记录关键运行信息
- 能判断一条日志是否足以回答“何时、做了什么、结果怎样”
- 能为简单 Shell 任务保留标准输出和错误输出
没有日志时会丢失什么
交互式执行脚本时,命令输出直接显示在终端里,失败通常马上能看到。但脚本进入 cron、systemd timer 或其他调度器后,执行现场很快消失。只看最终文件是否生成,无法区分“任务没启动”“启动后中途失败”和“任务成功但产物被后续步骤删除”。
因此,自动化日志至少要能回答三个问题:任务什么时候开始,执行到哪个关键阶段,以及最终成功还是失败。发生异常时,还应保留足够的错误信息,使排查可以从具体命令或阶段开始,而不是重新猜测整个执行过程。
先把标准输出和错误输出保存下来
最小可用做法,是把标准输出和标准错误都追加到日志文件。下面的示例用临时文件模拟一次任务,并故意制造失败,运行后可以直接看到完整证据链。
#!/usr/bin/env bash
set -u
log_file="$(mktemp)"
# 关键阶段主动写入时间和状态,便于还原执行顺序。
echo "[$(date '+%Y-%m-%d %H:%M:%S')] job started" >>"$log_file"
echo "processing input" >>"$log_file"
# 同时收集命令的标准输出和标准错误。
if { echo "simulated command error" >&2; false; } >>"$log_file" 2>&1; then
echo "[$(date '+%Y-%m-%d %H:%M:%S')] job succeeded" >>"$log_file"
else
status=$?
echo "[$(date '+%Y-%m-%d %H:%M:%S')] job failed, exit=$status" >>"$log_file"
fi
cat "$log_file"
rm -f "$log_file"预期输出(时间会随实际执行变化):
[<TIME>] job started
processing input
simulated command error
[<TIME>] job failed, exit=1这里最重要的不是错误文本本身,而是日志把“任务已启动”“核心步骤发生错误”“退出码为 1”连成了一条证据链。相比只收到一个“任务失败”的通知,这些信息已经能显著缩小排查范围。
日志应该记录哪些节点
日志不需要覆盖每一条命令。记录过密会让真正有价值的信息被淹没。更实用的做法是在任务边界和关键阶段写日志,例如任务开始、输入准备完成、核心处理开始、外部命令失败、产物写入完成和任务结束。
对于批处理脚本,还应记录能够定位当前处理对象的信息,例如文件名、批次号或远端主机名;但不要把密码、令牌、私钥或完整连接串写入日志。日志是排障材料,也可能被集中采集和长期保存,因此敏感信息一旦输出,影响范围通常比终端临时显示更大。
只重定向输出还不够
把所有输出写进文件只能解决“有记录”的问题,还没有解决“记录是否易读”。不同命令产生的文本格式不一致,后续搜索时很难快速区分普通进度、警告和真正的失败。
当脚本开始包含多个步骤时,应进一步统一日志格式,例如固定时间、级别和消息结构。这样既方便人工使用 grep 检索,也方便日志平台按关键字筛选。自动化脚本真正可观察的标准,不是日志文件存在,而是失败后能够沿着日志快速找到最后一个正常阶段和第一个异常阶段。