如何优雅地记录Shell脚本的执行日志

创作时间:

作者:

@小白创作中心

如何优雅地记录Shell脚本的执行日志

引用

CSDN

https://blog.csdn.net/zhangkunls/article/details/141730779

在Shell脚本开发中，如何优雅地记录执行日志是一个常见需求。本文将介绍一个简单实用的日志记录函数，帮助你轻松实现脚本运行情况的记录，包括时间戳和日志文件大小控制等功能。

需求分析：把日志搞得明明白白

我们需要一个功能强大的日志函数，能够实现以下几个目标：

记录脚本的运行情况：这包括脚本输出的各种信息，无论是字符串、变量值，还是命令的执行结果。
记录时间戳：每条日志信息都应该带有精确的时间戳，方便我们追溯脚本的执行过程。
控制日志文件的大小：日志文件随着时间的推移会不断增大，所以需要在日志达到一定行数时，删除最早的日志记录，以避免日志文件无限制地增长。

实现思路：三天三夜后的优雅代码

经过不懈的努力，我们写出了一个简单而实用的日志记录函数 log()，它可以轻松地集成到任何Shell脚本中。下面是代码的核心部分：

#!/bin/bash
log(){
local fileName="./$(basename $0 .sh).log"  # log文件名
local fileMaxLen=100  # log文件最大行数
local fileDeleteLen=10  # 达到最大行数后删除的行数
if test $fileName; then
echo "[`date +%y/%m/%d-%H:%M:%S`]:$*" >> $fileName
loglen=`grep -c "" $fileName`
if [ $loglen -gt $fileMaxLen ]; then
sed -i '1,'$fileDeleteLen'd' $fileName
fi
else
echo "[`date +%y/%m/%d-%H:%M:%S`]:$*" > $fileName
fi
}

这个函数非常简洁，但功能却很强大。它自动生成一个与脚本同名的日志文件，并且会在日志行数超过设定的最大值时，从文件顶部开始删除旧的日志记录。

实战演练：给脚本加点“料”

假设我们需要实时监控CPU温度，并记录每次监控的结果。通常我们会使用如下脚本：

echo CPU temperature is $[`cat /sys/class/thermal/thermal_zone0/temp`/1000]

通过watch命令可以每秒自动运行这个脚本，并实时查看温度变化：

watch -n 1 ./cputemp.sh

但是，这种方式虽然可以实时监控，却无法保存历史数据，稍不留神就错过了关键的温度变化。于是我们把之前写的 log() 函数加到脚本中，修改后的脚本如下：

#!/bin/bash
log(){
local fileName="./$(basename $0 .sh).log"
local fileMaxLen=100
local fileDeleteLen=10
if test $fileName; then
echo "[`date +%y/%m/%d-%H:%M:%S`]:$*" >> $fileName
loglen=`grep -c "" $fileName`
if [ $loglen -gt $fileMaxLen ]; then
sed -i '1,'$fileDeleteLen'd' $fileName
fi
else
echo "[`date +%y/%m/%d-%H:%M:%S`]:$*" > $fileName
fi
}
echo CPU temperature is $[`cat /sys/class/thermal/thermal_zone0/temp`/1000]
log "CPU temperature is $[`cat /sys/class/thermal/thermal_zone0/temp`/1000]"

现在，你只需要运行脚本，日志文件就会自动生成并记录每次的温度信息。通过cat ./cputemp.log可以查看日志，发现温度变化一目了然。

遇到的“坑”：挖坑容易填坑难

当然，开发过程中也遇到了一些“坑”，例如：

watch命令的限制：你可能会想到直接在脚本里使用watch命令来实现监控，但这会导致监控数据固定化，无法实时更新。最好的办法还是让watch命令单独运行，而脚本负责记录日志。
单引号里的变量引用问题：在使用sed命令时，如果需要在单引号内引用变量，需要对变量进行单引号嵌套处理，不然会报错。比如：

sed -i '1,'$fileDeleteLen'd' $fileName