log4j 将标准输出重定向到 DailyRollingFileAppender

Question

我有一个使用 log4j 的 java 应用程序。

配置：

log4j.rootLogger=info, file

log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File=${user.home}/logs/app.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d [%t] %c %p %m%n

所以所有日志语句都正确附加到文件中，但我丢失了标准输出和标准错误。如何将异常堆栈跟踪和系统输出重定向到每日滚动文件？

Answer 1

// I set up a ConsoleAppender in Log4J to format Stdout/Stderr
log4j.rootLogger=DEBUG, CONSOLE
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=[%t] %-5p %c - %m%n


// And I call this StdOutErrLog.tieSystemOutAndErrToLog() on startup

public class StdOutErrLog {

    private static final Logger logger = Logger.getLogger(StdOutErrLog.class);

    public static void tieSystemOutAndErrToLog() {
        System.setOut(createLoggingProxy(System.out));
        System.setErr(createLoggingProxy(System.err));
    }

    public static PrintStream createLoggingProxy(final PrintStream realPrintStream) {
        return new PrintStream(realPrintStream) {
            public void print(final String string) {
                realPrintStream.print(string);
                logger.info(string);
            }
        };
    }
}

Answer 2

我从 Michael S. 那里得到了这个想法，但就像在一条评论中提到的那样，它存在一些问题：它不能捕获所有内容，并且会打印一些空行。

我还想将System.out 和System.err 分开，这样System.out 的日志级别为'INFO'，System.err 的日志级别为'ERROR'（或'WARN'，如果你愿意）。

所以这是我的解决方案： 首先是扩展OutputStream 的类（覆盖OutputStream 的所有方法比覆盖PrintStream 更容易）。它以指定的日志级别记录，并将所有内容复制到另一个OutputStream。它还检测“空”字符串（仅包含空格）并且不记录它们。

import java.io.IOException;
import java.io.OutputStream;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class LoggerStream extends OutputStream
{
private final Logger logger;
private final Level logLevel;
private final OutputStream outputStream;

public LoggerStream(Logger logger, Level logLevel, OutputStream outputStream)
{
    super();

    this.logger = logger;
    this.logLevel = logLevel;
    this.outputStream = outputStream;
}

@Override
public void write(byte[] b) throws IOException
{
    outputStream.write(b);
    String string = new String(b);
    if (!string.trim().isEmpty())
        logger.log(logLevel, string);
}

@Override
public void write(byte[] b, int off, int len) throws IOException
{
    outputStream.write(b, off, len);
    String string = new String(b, off, len);
    if (!string.trim().isEmpty())
        logger.log(logLevel, string);
}

@Override
public void write(int b) throws IOException
{
    outputStream.write(b);
    String string = String.valueOf((char) b);
    if (!string.trim().isEmpty())
        logger.log(logLevel, string);
}
}

然后是一个非常简单的实用程序类来设置out 和err：

import java.io.PrintStream;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class OutErrLogger
{
public static void setOutAndErrToLog()
{
    setOutToLog();
    setErrToLog();
}

public static void setOutToLog()
{
    System.setOut(new PrintStream(new LoggerStream(Logger.getLogger("out"), Level.INFO, System.out)));
}

public static void setErrToLog()
{
    System.setErr(new PrintStream(new LoggerStream(Logger.getLogger("err"), Level.ERROR, System.err)));
}

}

Answer 3

在 Skaffman 代码中：要删除 log4j 日志中的空行，只需在 createLoggingProxy 的 PrintStream 中添加“println”方法

public static PrintStream createLoggingProxy(final PrintStream realPrintStream) {
    return new PrintStream(realPrintStream) {
        public void print(final String string) {
            logger.warn(string);
        }
        public void println(final String string) {
            logger.warn(string);
        }
    };
}

Answer 4

如果您使用的是应用服务器、servlet 容器或类似的东西，请参阅kgiannakakis's answer。

对于独立应用，请参阅this。您可以使用java.lang.System 类重新评估stdin、stdout 和stderr。基本上，您创建一个新的 PrintStream 子类并将该实例设置为 System.out。

在您的应用启动时有类似的内容（未经测试）。

// PrintStream object that prints stuff to log4j logger
public class Log4jStream extends PrintStream {
      public void write(byte buf[], int off, int len) {
        try {
           // write stuff to Log4J logger
        } catch (Exception e) {
       }
    }
}

// reassign standard output to go to log4j
System.setOut(new Log4jStream());

Answer 5

上面的答案给出了使用代理进行 STDOUT/ERR 日志记录的好主意。但是，提供的实现示例并不适用于所有情况。例如，尝试

System.out.printf("测试 %s\n", "ABC");

上面示例中的代码将在控制台上将输出切割成单独的部分，并分成多个不可读的 Log4j 条目。

解决方案是缓冲输出，直到在缓冲区末尾找到触发器'\n'。有时缓冲区以 '\r\n' 结尾。 下面的课程解决了这个问题。它功能齐全。调用静态方法bind()来激活它。

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

// Based on
// http://stackoverflow.com/questions/1200175/log4j-redirect-stdout-to-dailyrollingfileappender
public class Log4jStdOutErrProxy {

  public static void bind() {
    bind(Logger.getLogger("STDOUT"), Logger.getLogger("STDERR"));
  }

  @SuppressWarnings("resource")
  public static void bind(Logger loggerOut, Logger loggerErr) {
    System.setOut(new PrintStream(new LoggerStream(loggerOut, Level.INFO,  System.out), true));
    System.setErr(new PrintStream(new LoggerStream(loggerErr, Level.ERROR, System.err), true));
  }

  private static class LoggerStream extends OutputStream {
    private final Logger logger;
    private final Level logLevel;
    private final OutputStream outputStream;
    private StringBuilder sbBuffer;

    public LoggerStream(Logger logger, Level logLevel, OutputStream outputStream) {
      this.logger = logger;
      this.logLevel = logLevel;
      this.outputStream = outputStream;
      sbBuffer = new StringBuilder();
    }

    @Override
    public void write(byte[] b) throws IOException {
      doWrite(new String(b));
    }

    @Override
    public void write(byte[] b, int off, int len) throws IOException {
      doWrite(new String(b, off, len));
    }

    @Override
    public void write(int b) throws IOException {
      doWrite(String.valueOf((char)b));
    }

    private void doWrite(String str) throws IOException {
      sbBuffer.append(str);
      if (sbBuffer.charAt(sbBuffer.length() - 1) == '\n') {
        // The output is ready
        sbBuffer.setLength(sbBuffer.length() - 1); // remove '\n'
        if (sbBuffer.charAt(sbBuffer.length() - 1) == '\r') {
          sbBuffer.setLength(sbBuffer.length() - 1); // remove '\r'
        }
        String buf = sbBuffer.toString();
        sbBuffer.setLength(0);
        outputStream.write(buf.getBytes());
        outputStream.write('\n');
        logger.log(logLevel, buf);
      }
    }
  } // inner class LoggerStream  

}

Answer 6

对于那些寻找如何在 log4j2 中执行此操作的人。现在有一个组件可以为您创建这些流。

需要包含 log4j-iostreams jar
见：https://logging.apache.org/log4j/2.x/log4j-iostreams/index.html

例子：

PrintStream logger = IoBuilder.forLogger("System.out").setLevel(Level.DEBUG).buildPrintStream();
PrintStream errorLogger = IoBuilder.forLogger("System.err").setLevel(Level.ERROR).buildPrintStream();
System.setOut(logger);
System.setErr(errorLogger);

Answer 7

我想你是通过 e.printStackTrace() 记录堆栈跟踪？您可以将异常对象传递给 Log4j 日志记录方法，这些方法将出现在您的日志中（请参阅Logger.error(Object obj, Throwable t)）

请注意，您可以将 System.out 和 System.err 更改为另一个重定向到 Log4j 的 PrintStream。这将是一个简单的更改，并且可以节省您转换所有 System.out.println() 语句的时间。

Answer 8

标准输出和错误流由您的容器管理。例如 Tomcat 使用 JULI 来记录输出和错误流。

我的建议是保持原样。避免在您的应用程序中使用 System.out.print。有关堆栈跟踪，请参阅 here。

Answer 9

@Michael 的分析器是一个很好的观点。但是扩展 PrintStream 不是很好，因为它使用内部方法 void write(String) 将所有内容写入 OutputStream。

我更喜欢使用 Log4J Contrib 包中的 LoggingOutputStream Class。

然后我像这样重定向系统流：

public class SysStreamsLogger {
    private static Logger sysOutLogger = Logger.getLogger("SYSOUT");
    private static Logger sysErrLogger = Logger.getLogger("SYSERR");

    public static final PrintStream sysout = System.out;
    public static final PrintStream syserr = System.err;

    public static void bindSystemStreams() {
        // Enable autoflush
        System.setOut(new PrintStream(new LoggingOutputStream(sysOutLogger, LogLevel.INFO), true));
        System.setErr(new PrintStream(new LoggingOutputStream(sysErrLogger, LogLevel.ERROR), true));
    }

    public static void unbindSystemStreams() {
        System.setOut(sysout);
        System.setErr(syserr);
    }
}

Answer 10

在使用 System.setOut 和 System.setErr 方法之前，我们应该使用 reset() 方法重置 java.util.logging.LogManager 对象。

public static void tieSystemOutAndErrToLog() {

    try{

        // initialize logging to go to rolling log file
        LogManager logManager = LogManager.getLogManager();
        logManager.reset();

        // and output on the original stdout
        System.out.println("Hello on old stdout");
        System.setOut(createLoggingProxy(System.out));
        System.setErr(createLoggingProxy(System.err));

        //Following is to make sure whether system.out and system.err is redirecting to the stdlog.log file
        System.out.println("Hello world!");

        try {
            throw new RuntimeException("Test");
        } catch (Exception e) {
            e.printStackTrace();
        }

    }catch(Exception e){
        logger.error("Caught exception at StdOutErrLog ",e);
        e.printStackTrace();
    }
}