我希望每个文章通过一个简单小问题，来引导大家逐步深入了解学习shell，潜移默化的掌握shell编程的最佳实践。本文通过引入一个小问题以及解决方案来引导我们学习更多的shell命令行下时间的管理策略，以及了解这种管理方式在不同shell间的差异。

问题描述

在流中添加时间戳是一个挑战，因为没有标准工具可以完成这个任务。你可以安装针对此目的专门设计的工具（例如 moreutils 中的 ts，或者 daemontools 中的 multilog），或者使用某种编程语言编写过滤器。理想情况下，你不希望为每一行输入日志都创建一个 date(1) 命令的进程，因为这样太慢了。你应该使用内置工具。旧版本的 Bash 无法完成这个任务。你至少需要 Bash 4.2 版本才能使用 printf %(...)T 选项。否则，你可以使用 Perl、Python、Tcl 等编写程序来读取行并带有时间戳写出。

来尝试解决这个问题

在选择程序或编写函数（我们称之为 stamper）之后，你只需要将流通过它进行管道传输：

./myprogram 2>&1 | stamper > logfile

下面是一个简单的使用 Bash 4.2 的时间戳生成程序，以秒为单位进行精确度：

# Bash 4.2 or later
stamper() {
  while read -r; do
    printf '%(%Y-%m-%d %H:%M:%S)T %s\n' -1 "$REPLY"
  done
}

在支持 strftime(3) 中的 %s 的系统上，你还可以使用 %(%s)T 来生成 Unix 时间戳。但遗憾的是，这种方法不是可移植的。

Bash 5.0 添加了 EPOCHSECONDS（1 秒精度）和 EPOCHREALTIME（微秒精度）变量，可以替代（或与之一同使用）printf %()T：

# Bash 5.0 or later
stamper() {
  while read -r; do
    printf '%s %s\n' "$EPOCHREALTIME" "$REPLY"
  done
}

还有一个专门为此目的设计的外部工具是 moreutils 包中的 ts。它的默认格式选择不当（采用人类可读的月份名称，以 Mmm DD YYYY 格式显示），但你可以指定一个格式。它支持微秒精度。

stamper() {
    ts "%Y-%m-%d %H:%M:%S.%.S"
}

另一个选择是 multilog，它可以提供纳秒级精度:

stamper() {
  multilog t e 2>&1
}

multilog 的 -e 选项告诉它将每一行写入 stderr，而不是自动轮转目录中的文件。multilog 使用 TAI64N 格式写入时间戳，类似于 Unix epoch 格式。你可以使用转换工具（例如 tai64nlocal）将其转换为可读格式。

以下是使用 Tcl 的示例，精度为微秒:

#!/usr/bin/env tclsh
while {[gets stdin line] >= 0} {
    set now [clock microseconds]
    set frac [expr {$now % 1000000}]
    set now [expr {$now / 1000000}]
    puts "[clock format $now -format {%Y-%m-%d %H:%M:%S}].$frac $line"
}

这最好作为一个单独的、独立的脚本来使用。把它嵌入到bash函数中也是可以的，尽管很难看：

stamper() {
  tclsh <(cat <<\EOF
    while {[gets stdin line] >= 0} {
      set now [clock microseconds]
      set frac [expr {$now % 1000000}]
      set now [expr {$now / 1000000}]
      puts "[clock format $now -format {%Y-%m-%d %H:%M:%S}].$frac $line"
    }
EOF
  )
}

对于 Perl 爱好者，以下是一个精度为1秒的示例:

stamper() {
    perl -p -e '$|=1; @l=localtime; printf "%04d-%02d-%02d %02d:%02d:%02d ",
        1900+$l[5], $l[4], $l[3], $l[2], $l[1], $l[0]'
}

从上述选择中选择一个，或者用你喜欢的编程语言编写另一个（或更好的）。

现在，在这一点上，一些读者可能要问如何在记录带有时间戳的流到文件的同时查看未修改的流。假设他们不完全疯狂，所以他们不关心 stdout 和 stderr 的分离。他们只想要将所有内容按照顺序混合在一个文件中，包括 stdout 和 stderr。

现在，运行脚本使其输出和 stderr 正常显示到屏幕，将带有时间戳的行写入日志文件相对容易：

./myscript 2>&1 | tee >(stamper >logfile)

将同样的内容放入一个脚本中稍微复杂一些：

#!/bin/bash
exec > >(tee >(stamper >logfile)) 2>&1

while sleep 0.2s; do
    echo "TPS report $RANDOM"
done

当然，如果脚本中写入 stamper 的部分使用 stdout 缓冲区，可能会存在缓冲问题。请考虑这一点。

我不在乎速度有多慢！我希望每秒调用 date(1) 一千次！我的电脑可以当作加热器使用！
这是低效和可怕的。

stamper() {
  while read -r; do
    printf '%s %s\n' "$(date +'%Y-%m-%d %H:%M:%S')" "$REPLY"
  done
}

PS：请不要使用这种方法。这是愚蠢的。

More

如果你想学习如何编写更加健壮和可靠的 Shell 脚本，减少生产环境中的错误和故障，那么关注我吧！我会分享 Shell 编程的最佳实践和建议，帮助你提高 Shell 脚本的鲁棒性和可维护性。如果你想深入了解 Shell 编程的实际应用和技巧，可以关注我的《Shell 脚本编程最佳实践》专栏，里面有我在一线互联网大厂的实际生产经验和最佳实践，帮助你高效完成各种自动化任务。