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

把各项巡检拆成独立函数

把各项巡检拆成独立函数

巡检脚本一旦把所有命令堆在 main 里,就很难单独测试、复用和定位失败。本节把主机名、运行时长和目录可写性拆成独立函数,再用统一包装器处理参数、返回状态与日志,让新增检查项只需要增加一个函数。

学习目标

  • 能按单一职责把巡检项拆成独立 Shell 函数
  • 能用统一约定组织函数参数、标准输出和返回码
  • 能通过公共执行器集中记录成功与失败日志

先统一函数契约

巡检函数最好只负责“检查并给出结果”,不要在每个函数里重复时间戳、日志级别和错误格式。这里约定:函数把可读结果写到标准输出,成功返回 0,失败返回非 0;需要的目标对象通过位置参数传入。

这样主流程不需要理解每项检查的内部实现,只要调用函数并判断返回码。函数也可以被单独执行或替换,后续加入 CPU、内存等资源检查时不必修改日志框架。

拆分检查函数并统一执行

下面示例适用于常见 Linux 环境。run_check 接收“检查名称 + 函数名 + 函数参数”,负责捕获输出、判断返回码并记录日志;三个检查函数只处理各自职责。

bash
#!/usr/bin/env bash

set -u

log() {
  local level=$1
  shift
  printf '%s [%s] %s\n' "$(date '+%Y-%m-%dT%H:%M:%S%z')" "$level" "$*"
}

check_hostname() {
  local host
  host=$(hostname) || return 1
  printf 'hostname=%s\n' "$host"
}

check_uptime() {
  local value
  value=$(uptime -p) || return 1
  printf 'uptime=%s\n' "$value"
}

check_writable_path() {
  local path=$1
  if [[ -w "$path" ]]; then
    printf 'writable=%s\n' "$path"
    return 0
  fi

  printf 'not_writable=%s\n' "$path"
  return 2
}

run_check() {
  local name=$1
  shift
  local output

  if output=$("$@"); then
    log INFO "$name ok: $output"
    return 0
  else
    local rc=$?
    log ERROR "$name failed(rc=$rc): $output"
    return "$rc"
  fi
}

main() {
  local failures=0

  if ! run_check hostname check_hostname; then
    ((failures += 1))
  fi
  if ! run_check uptime check_uptime; then
    ((failures += 1))
  fi
  if ! run_check tmp-write check_writable_path /tmp; then
    ((failures += 1))
  fi

  log INFO "inspection finished: failures=$failures"
  return "$failures"
}

main "$@"

预期输出(时间、主机名和运行时长会因机器而异):

text
<TIME> [INFO] hostname ok: hostname=<HOST>
<TIME> [INFO] uptime ok: uptime=<UPTIME>
<TIME> [INFO] tmp-write ok: writable=/tmp
<TIME> [INFO] inspection finished: failures=0

返回码要表达程序状态

日志是给人看的,返回码是给调用方看的。0 表示检查成功;例如目录不可写时返回 2,包装器继续记录失败详情。main 汇总失败数量后把它作为最终退出码,因此定时任务或上层批处理既能看到日志,也能直接通过 $? 判断整次巡检是否成功。

如果未来检查项很多,不要让单个函数承担“采集、阈值判断、打印整份报告、发送通知”全部职责。先保持每个函数输入明确、输出稳定、返回码可预测,再在公共层统一编排,脚本才容易扩展和测试。

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

目录与阅读设置

阅读设置

17

记录一个想法

把各项巡检拆成独立函数

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

登录哪都通