从 bash 脚本本身将 stdout 的副本重定向到日志文件

Question

我知道如何重定向标准输出到一个文件：

exec > foo.log
echo test

这会将“测试”放入 foo.log 文件中。

现在我想将输出重定向到日志文件并将其保留在标准输出中

即它可以从脚本外部轻松完成：

script | tee foo.log

但我想在脚本本身中声明它

我试过了

exec | tee foo.log

但是没有用。

Answer 1

#!/usr/bin/env bash

# Redirect stdout ( > ) into a named pipe ( >() ) running "tee"
exec > >(tee -i logfile.txt)

# Without this, only stdout would be captured - i.e. your
# log file would not contain any error messages.
# SEE (and upvote) the answer by Adam Spiers, which keeps STDERR
# as a separate stream - I did not want to steal from him by simply
# adding his answer to mine.
exec 2>&1

echo "foo"
echo "bar" >&2

请注意，这是bash，而不是sh。如果您使用sh myscript.sh 调用脚本，您将收到与syntax error near unexpected token '>' 类似的错误。

如果您正在使用信号陷阱，您可能需要使用tee -i 选项以避免在出现信号时中断输出。 （感谢 JamesThomasMoon1979 的评论。）

---

根据写入管道还是终端来更改其输出的工具（例如，ls 使用颜色和列输出）将检测到上述构造意味着它们输出到管道。

有一些选项可以强制着色/列化（例如ls -C --color=always）。请注意，这将导致颜色代码也被写入日志文件，使其不那么可读。

Answer 2

接受的答案不会将 STDERR 保留为单独的文件描述符。这意味着

./script.sh >/dev/null

不会将bar输出到终端，只会输出到日志文件，并且

./script.sh 2>/dev/null

将foo 和bar 输出到终端。显然那不是 普通用户可能期望的行为。这可以是 通过使用两个单独的 tee 进程来修复，这两个进程都附加到相同的 日志文件：

#!/bin/bash

# See (and upvote) the comment by JamesThomasMoon1979 
# explaining the use of the -i option to tee.
exec >  >(tee -ia foo.log)
exec 2> >(tee -ia foo.log >&2)

echo "foo"
echo "bar" >&2

（请注意，上述内容最初不会截断日志文件 - 如果您想要这种行为，您应该添加

>foo.log

到脚本的顶部。）

POSIX.1-2008 specification of tee(1) 要求输出是无缓冲的，即甚至不是行缓冲的，因此在这种情况下，STDOUT 和 STDERR 可能最终在 foo.log 的同一行上；但是，这也可能发生在终端上，因此日志文件将忠实反映终端上 可以看到的内容，如果不是它的精确镜像的话。如果您希望 STDOUT 行与 STDERR 行完全分离，请考虑使用两个日志文件，每行可能带有日期戳前缀，以便以后按时间顺序重新组装。

Answer 3

busybox、macOS bash 和非 bash shell 的解决方案

公认的答案无疑是 bash 的最佳选择。我在无法访问 bash 的 Busybox 环境中工作，并且它不理解 exec > >(tee log.txt) 语法。它也没有正确执行exec >$PIPE，试图创建一个与命名管道同名的普通文件，但失败并挂起。

希望这对没有 bash 的其他人有用。

此外，对于使用命名管道的任何人，rm $PIPE 是安全的，因为这会取消管道与 VFS 的链接，但使用它的进程仍然会在其上维护一个引用计数，直到它们完成。

请注意，使用 $* 不一定安全。

#!/bin/sh

if [ "$SELF_LOGGING" != "1" ]
then
    # The parent process will enter this branch and set up logging

    # Create a named piped for logging the child's output
    PIPE=tmp.fifo
    mkfifo $PIPE

    # Launch the child process with stdout redirected to the named pipe
    SELF_LOGGING=1 sh $0 $* >$PIPE &

    # Save PID of child process
    PID=$!

    # Launch tee in a separate process
    tee logfile <$PIPE &

    # Unlink $PIPE because the parent process no longer needs it
    rm $PIPE    

    # Wait for child process, which is running the rest of this script
    wait $PID

    # Return the error code from the child process
    exit $?
fi

# The rest of the script goes here

Answer 4

在您的脚本文件中，将所有命令放在括号内，如下所示：

(
echo start
ls -l
echo end
) | tee foo.log

Answer 5

将 bash 脚本记录到 syslog 的简单方法。脚本输出可通过/var/log/syslog 和stderr 获得。 syslog 将添加有用的元数据，包括时间戳。

在顶部添加这一行：

exec &> >(logger -t myscript -s)

或者，将日志发送到单独的文件：

exec &> >(ts |tee -a /tmp/myscript.output >&2 )

这需要moreutils（用于添加时间戳的ts 命令）。

Answer 6

使用接受的答案，我的脚本一直异常早地返回（在 'exec > >(tee ...)' 之后），让我的脚本的其余部分在后台运行。由于我无法让该解决方案按我的方式工作，因此我找到了另一个解决方案/解决该问题：

# Logging setup
logfile=mylogfile
mkfifo ${logfile}.pipe
tee < ${logfile}.pipe $logfile &
exec &> ${logfile}.pipe
rm ${logfile}.pipe

# Rest of my script

这使得脚本的输出从进程通过管道进入“tee”的子后台进程，该进程将所有内容记录到光盘和脚本的原始标准输出。

请注意，'exec &>' 会同时重定向 stdout 和 stderr，如果我们愿意，我们可以分别重定向它们，或者如果我们只想要 stdout，则更改为 'exec >'。

即使您在脚本开始时从文件系统中删除了管道，它仍将继续运行，直到进程完成。我们只是不能使用 rm 行后面的文件名来引用它。

Answer 7

Bash 4 有一个coproc 命令，它为命令建立一个命名管道并允许您通过它进行通信。

Answer 8

不能说我对任何基于 exec 的解决方案都很满意。我更喜欢直接使用 tee，所以我在请求时使用 tee 使脚本自己调用：

# my script: 

check_tee_output()
{
    # copy (append) stdout and stderr to log file if TEE is unset or true
    if [[ -z $TEE || "$TEE" == true ]]; then 
        echo '-------------------------------------------' >> log.txt
        echo '***' $(date) $0 $@ >> log.txt
        TEE=false $0 $@ 2>&1 | tee --append log.txt
        exit $?
    fi 
}

check_tee_output $@

rest of my script

这允许你这样做：

your_script.sh args           # tee 
TEE=true your_script.sh args  # tee 
TEE=false your_script.sh args # don't tee
export TEE=false
your_script.sh args           # tee

您可以自定义它，例如将 tee=false 设为默认值，让 TEE 保存日志文件，等等。我猜这个解决方案类似于 jbarlow 的，但更简单，也许我的有一些我还没有遇到的限制。

Answer 9

这些都不是完美的解决方案，但您可以尝试以下几件事：

exec >foo.log
tail -f foo.log &
# rest of your script

或

PIPE=tmp.fifo
mkfifo $PIPE
exec >$PIPE
tee foo.log <$PIPE &
# rest of your script
rm $PIPE

如果你的脚本出现问题，第二个会留下一个管道文件，这可能是也可能不是问题（即，也许你可以在之后在父 shell 中 rm 它）。