命令行与文本处理 / 系统课时

写一个统一的日志函数

写一个统一的日志函数

脚本规模变大后,如果每个位置都手写 echo 和时间戳,格式很快会不一致。把日志输出封装成统一函数,可以让 INFO、WARN、ERROR 使用同一种结构,并把时间、级别和输出目标集中管理,后续改格式时只需要修改一处。

学习目标

  • 能封装统一的 INFO、WARN、ERROR 日志函数
  • 理解标准输出与标准错误在日志函数中的分工
  • 能在脚本失败路径中记录错误并保留原始退出状态

统一日志格式

一个实用的最小格式可以写成“时间 + 级别 + 消息”。时间用于还原执行顺序,级别用于筛选严重程度,消息说明发生了什么。

INFO 适合记录正常阶段进度,WARN 表示任务还能继续但出现值得关注的情况,ERROR 表示当前操作失败或脚本准备退出。对于需要被调度器识别的错误,除了写 ERROR 日志,还应返回非零退出码;日志不能替代 Shell 的退出状态。

封装可复用函数

下面的脚本定义一个底层 log 函数,再用三个轻量包装函数固定日志级别。普通日志写到标准输出,ERROR 写到标准错误,这样调用方既可以统一收集,也可以在需要时分别重定向。

bash
#!/usr/bin/env bash
set -u

log() {
  local level="$1"
  shift
  local timestamp
  timestamp="$(date '+%Y-%m-%d %H:%M:%S')"

  # ERROR 走标准错误,其他级别走标准输出。
  if [[ "$level" == "ERROR" ]]; then
    printf '[%s] [%s] %s\n' "$timestamp" "$level" "$*" >&2
  else
    printf '[%s] [%s] %s\n' "$timestamp" "$level" "$*"
  fi
}

# 包装函数让调用处只表达日志级别和业务消息。
log_info() {
  log "INFO" "$@"
}

log_warn() {
  log "WARN" "$@"
}

log_error() {
  log "ERROR" "$@"
}

log_info "backup started"
log_warn "temporary directory is almost full"

# false 用于稳定模拟失败,便于验证错误日志和退出码。
if false; then
  log_info "backup completed"
else
  status=$?
  log_error "backup failed, exit=$status"
fi

预期输出(时间会随实际执行变化):

text
[<TIME>] [INFO] backup started
[<TIME>] [WARN] temporary directory is almost full
[<TIME>] [ERROR] backup failed, exit=1

"$@" 会把调用方传入的全部消息参数继续交给 log,而 shift 先移除第一个级别参数。使用 printf 而不是依赖 echo 的转义行为,可以减少不同 Shell 环境下的输出差异。

保留失败命令的退出码

错误日志最常见的坑,是在读取 $? 之前又执行了一条命令。Shell 的 $? 只保存“上一条命令”的退出状态,因此必须在失败分支进入后立刻保存。

bash
if some_command; then
  log_info "some_command completed"
else
  status=$?
  log_error "some_command failed, exit=$status"
  exit "$status"
fi

这段是片段示例,依赖前面已经定义好的日志函数和真实存在的 some_command。它的生效行为是:命令失败时先保存原始退出码,记录 ERROR,再用同一个退出码结束脚本。验证时可把 some_command 替换为 false,然后检查脚本退出状态。

预期结果:当替换为 false 时会输出一条 ERROR 日志,脚本退出码为 1。

让调用方式保持简单

日志函数的价值在于让业务步骤保持可读。调用处只需要表达事件本身,例如 log_info "archive created",而不应该重复拼时间戳、级别或输出目标。以后如果要增加脚本名、进程号或统一写入文件,只需要修改 log 函数。

如果脚本会被 cron 或其他调度器运行,可以在调度层把标准输出和标准错误都追加到同一个日志文件;如果监控系统分别采集两个流,则保留 ERROR 到标准错误更有利于告警。无论采用哪种收集方式,统一函数都应只负责生成稳定、可检索的日志行,具体保存位置由运行环境决定。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

写一个统一的日志函数

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通