LinuxShell日志规范设计_脚本日志实践

6次阅读

linux shell脚本日志必须包含iso8601时间戳、大写级别、脚本名与pid、消息内容四字段,通过封装log函数统一输出,配合错误三态记录和自动轮转管理。

LinuxShell日志规范设计_脚本日志实践

Linux Shell 脚本的日志规范不是可有可无的装饰,而是排查问题、追踪执行、审计操作的关键依据。没有统一格式的日志,出问题时只能靠猜;缺乏时间戳、级别、来源标识的日志,等于没记。

日志必须包含的四个基础字段

每条日志行应至少包含以下四部分,用空格或制表符分隔,便于后续用 awk/grep/cut 解析:

  • ISO8601 时间戳:如 2024-05-22T14:23:06+0800,推荐用 date -Is(注意:部分老系统不支持 -I,可用 date "+%Y-%m-%dT%H:%M:%S%z" 兼容)
  • 日志级别:统一用大写英文,如 INFOWARNErrorDEBUG,避免混用 info / Info
  • 脚本名与 PID:如 backup.sh[12345],方便区分多实例并发运行
  • 实际消息内容:不带换行,关键参数建议加引号,如 "src=/data/log" "ret=1"

示例完整日志行:
2024-05-22T14:23:06+0800 INFO backup.sh[12345] "src=/data/log" "dst=/backup/20240522" "ret=0"

用函数封装日志输出,禁止直接 echo

在脚本开头定义统一日志函数,强制走同一出口,便于集中控制格式、重定向、开关调试日志:

LOG_LEVEL="INFO"  # 可从环境变量或参数读取 LOG_FILE="/var/log/myscript.log" <p>log() { local level="$1"; shift local msg="$*"</p><h1>级别过滤:只输出 >= 当前等级的日志(ERROR > WARN > INFO > DEBUG)</h1><p>case "$level" in ERROR) [[ "$LOG_LEVEL" =~ ^(ERROR|WARN|INFO|DEBUG)$ ]] || return ;; WARN)  [[ "$LOG_LEVEL" =~ ^(WARN|INFO|DEBUG)$ ]] || return ;; INFO)  [[ "$LOG_LEVEL" =~ ^(INFO|DEBUG)$ ]] || return ;; DEBUG) [[ "$LOG_LEVEL" == "DEBUG" ]] || return ;; esac printf "%s %s %s[%d] %sn"  "$(date '+%Y-%m-%dT%H:%M:%S%z')"  "$level"  "$(basename "$0")" "$$"  "$msg" >> "$LOG_FILE" 2>/dev/NULL }</p><h1>使用方式</h1><p>log INFO "starting backup task" log WARN "disk usage over 90%" log ERROR "rsync failed with exit code $?"

错误处理与退出日志必须成对出现

Shell 脚本易因命令失败静默中断,务必在关键步骤后检查返回值,并记录明确的“开始/结束/失败”三态日志:

  • 执行前记录 log INFO "running: rsync -a ..."
  • 执行后立即判断 $?,成功则记 log INFO "rsync completed",失败则记 log ERROR "rsync failed: $?" 并调用 exit 1
  • 整个脚本结尾加 log INFO "script finished successfully",异常退出前确保有对应 ERROR 日志

避免只记“成功”不记“失败”,更不要让脚本在无日志情况下静默退出。

日志文件管理要主动,不依赖外部轮转

Shell 脚本通常不跑在 systemd 或 logrotate 环境下,需自行保障日志可控:

  • 启动时检查日志目录是否存在,不存在则创建:mkdir -p "$(dirname "$LOG_FILE")"
  • 单文件大小超限(如 10MB)自动归档:[[ $(stat -c%s "$LOG_FILE" 2>/dev/null || echo 0) -gt $((10*1024*1024)) ]] && mv "$LOG_FILE" "${LOG_FILE}.$(date +%Y%m%d_%H%M%S)"
  • 最多保留最近 7 个归档:find "$(dirname "$LOG_FILE")" -name "$(basename "$LOG_FILE").*" -mtime +7 -delete

不设限的日志会撑爆磁盘,而完全依赖管理员手动清理,等于没管。

text=ZqhQzanResources