如何将堆栈跟踪发送到 log4j？

Question

假设你捕获了一个异常并在标准输出（比如控制台）上得到以下信息，如果你执行 e.printStackTrace()：

java.io.FileNotFoundException: so.txt
        at java.io.FileInputStream.<init>(FileInputStream.java)
        at ExTest.readMyFile(ExTest.java:19)
        at ExTest.main(ExTest.java:7)

现在我想将它发送到一个记录器，比如 log4j，以获得以下信息：

31947 [AWT-EventQueue-0] ERROR Java.io.FileNotFoundException: so.txt
32204 [AWT-EventQueue-0] ERROR    at java.io.FileInputStream.<init>(FileInputStream.java)
32235 [AWT-EventQueue-0] ERROR    at ExTest.readMyFile(ExTest.java:19)
32370 [AWT-EventQueue-0] ERROR    at ExTest.main(ExTest.java:7)

我该怎么做？

try {
   ...
} catch (Exception e) {
    final String s;
    ...  // <-- What goes here?
    log.error( s );
}

Answer 1

您将异常直接传递给记录器，例如

try {
   ...
} catch (Exception e) {
    log.error( "failed!", e );
}

由 log4j 来呈现堆栈跟踪。

Answer 2

您还可以通过ExceptionUtils.getStackTrace 以字符串形式获取堆栈跟踪。

见：ExceptionUtils.java

我只将它用于log.debug，以保持log.error 简单。

Answer 3

创建这个class：

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) {
            logger.info(string);
        }
        public void println(final String string) {
            logger.info(string);
        }
    };
}
}

在你的代码中调用它

StdOutErrLog.tieSystemOutAndErrToLog();

Answer 4

此答案可能与提出的问题无关，但与问题的标题有关。

public class ThrowableTest {

    public static void main(String[] args) {

        Throwable createdBy = new Throwable("Created at main()");
        ByteArrayOutputStream os = new ByteArrayOutputStream();
        PrintWriter pw = new PrintWriter(os);
        createdBy.printStackTrace(pw);
        try {
            pw.close();
            os.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
        logger.debug(os.toString());
    }
}

或

public static String getStackTrace (Throwable t)
{
    StringWriter stringWriter = new StringWriter();
    PrintWriter  printWriter  = new PrintWriter(stringWriter);
    t.printStackTrace(printWriter);
    printWriter.close();    //surprise no IO exception here
    try {
        stringWriter.close();
    }
    catch (IOException e) {
    }
    return stringWriter.toString();
}

或

StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
for(StackTraceElement stackTrace: stackTraceElements){
    logger.debug(stackTrace.getClassName()+ "  "+ stackTrace.getMethodName()+" "+stackTrace.getLineNumber());
}

Answer 5

只是因为它发生在我身上并且可能有用。 如果你这样做

try {
   ...
} catch (Exception e) {
    log.error( "failed! {}", e );
}

您将获得异常的标头，而不是整个堆栈跟踪。因为记录器会认为您正在传递一个字符串。 正如 skaffman 所说，不用 {} 就可以了

Answer 6

如果您想在不涉及异常的情况下记录堆栈跟踪，只需执行以下操作：

String message = "";

for(StackTraceElement stackTraceElement : Thread.currentThread().getStackTrace()) {                         
    message = message + System.lineSeparator() + stackTraceElement.toString();
}   
log.warn("Something weird happened. I will print the the complete stacktrace even if we have no exception just to help you find the cause" + message);

Answer 7

skaffman 的答案绝对是正确的答案。 error()、warn()、info()、debug() 等所有 logger 方法都将 Throwable 作为第二个参数：

try {
...
 } catch (Exception e) {
logger.error("error: ", e);
}

但是，您也可以将堆栈跟踪提取为字符串。有时，如果您希望使用“{}”占位符来利用格式化功能，这可能会很有用 - 请参阅方法 void info(String var1, Object... var2); 在这种情况下，假设您有一个堆栈跟踪作为字符串，那么您实际上可以执行以下操作：

try {
...
 } catch (Exception e) {
String stacktrace = TextUtils.getStacktrace(e);
logger.error("error occurred for usename {} and group {}, details: {}",username, group, stacktrace);
}

这将在最后打印参数化消息和堆栈跟踪，方法与方法相同：logger.error("error: ", e);

实际上，我编写了一个开源库，其中包含一个实用程序，用于将堆栈跟踪提取为字符串，并且可以选择巧妙地从堆栈跟踪中过滤掉一些噪音。 IE。如果您指定您对提取的堆栈跟踪感兴趣的包前缀，则会从一些不相关的部分中过滤掉，并为您留下非常简洁的信息。这是文章的链接，该链接解释了该库具有哪些实用程序以及从何处获取它（作为 maven 工件和 git 源）以及如何使用它。 Open Source Java library with stack trace filtering, Silent String parsing Unicode converter and Version comparison 见段落“Stacktrace 噪声过滤器”

Answer 8

这将是很好的 log4j 错误/异常日志记录 - 可由 splunk/其他日志记录/监控软件读取。一切都是键值对的形式。 log4j 将从 Exception obj e 获取堆栈跟踪

    try {
          ---
          ---
    } catch (Exception e) {
        log.error("api_name={} method={} _message=\"error description.\" msg={}", 
                  new Object[]{"api_name", "method_name", e.getMessage(), e});
    }

Answer 9

Try this:

catch (Throwable t) {
    logger.error("any message" + t);
    StackTraceElement[] s = t.getStackTrace();
    for(StackTraceElement e : s){
        logger.error("\tat " + e);
    }   
}

Answer 10

您可以使用以下代码：

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;

public class LogWriterUtility {
    Logger log;

    public LogWriterUtility(Class<?> clazz) {
        log = LogManager.getLogger(clazz);
    }

public void errorWithAnalysis( Exception exception) {

        String message="No Message on error";
        StackTraceElement[] stackTrace = exception.getStackTrace();
        if(stackTrace!=null && stackTrace.length>0) {
            message="";
            for (StackTraceElement e : stackTrace) {
                message += "\n" + e.toString();
            }
        }
        log.error(message);


    }

}

您可以在这里拨打：LogWriterUtility.errorWithAnalysis( YOUR_EXCEPTION_INSTANCE);

它会将 stackTrace 打印到您的日志中。

Answer 11

在 Log4j 2 中，您可以使用 Logger.catching() 从捕获的异常中记录堆栈跟踪。

    try {
        String msg = messages[messages.length];
        logger.error("An exception should have been thrown");
    } catch (Exception ex) {
        logger.catching(ex);
    }