日志记录:将日志与正在创建的对象相关联



我有一个带有MainService的Spring Boot项目,该项目使用了几个helper方法和其他"微服务;为了创建FinalObject,它最终使用Hibernate/JPA持久化。方法和服务可能会记录几个消息,我希望这些消息与记录事件发生时创建的对象相关联。

问题是helper方法和微服务无法访问finalObject实例,因此即使所有内容都被记录下来,也只有捕获的异常会被保存为finalObject属性,而不是警告消息或其他日志:

class FinalObject {
private int value;
private int price;
private List<String> logs;
...
}
class MainService {
@Autowired ValueService valueService;  // + other services
void createFinalObject() {  // Main method
FinalObject o1 = new FinalObject();
try {
o1.setValue(valueService.getValue("some argument"));
}
catch (Exception e) {
log.error(e.toString());  // Logging using Log4j2
o1.addLog(e.toString());  // If there's an exception, I can easily log it to a o1 attribute.
}
o1.setPrice(calculatePrice(o1.getValue()));
...
}
int calculatePrice(int value) {  // Helper method
if (value > getMarketPrice())
log.info("This is very valuable!");  // I need a way to associate this with o1!
...
return price;
}
}
// ValueService.java
int getValue(String arg) {
if (arg.matches("\d$"))
log.warn("arg ends with a number");  // Must also be saved to o1!
...
return value;
}

解决方案1:到处传递o1

int calculatePrice(int value, FinalObject o1) {
if (value > getMarketPrice()) {
o1.addLog("This is very valuable!");  // Now I have access to o1 here
log.info("This is very valuable!");
}
...

解决方案2:将o1logs属性作为可修改列表传递:

o1.setPrice(calculatePrice(o1.getValue(), o1.getLogs()));
...
int calculatePrice(int value, List<String> finalObjectLogs) {
if (value > getMarketPrice()) {
finalObjectLogs.add("This is very valuable!");  // Directly modify o1's logs attribute
log.info("This is very valuable!");
}
...

解决方案3:添加一个log4j2数据库附加程序

一个更优雅的解决方案可能是在log4j2中添加一个数据库附加程序。这方面的一个挑战是如何将这些日志与o1关联起来。FinalObjectid只在createFinalObject()的最后生成,当它被保存到数据库时,所以在执行日志语句时我没有id。

问题:

我怎么能比上面提到的方式更优雅地做到这一点呢?

或者:

如果解决方案3看起来是一个不错的方法,我该如何实现它?

我很好奇。在你的例子中,计算价格的方法似乎与任何对象都无关,那么你为什么要在其中包含特定对象的信息呢?

另一方面,如果您想将其与单个请求中执行的其他操作关联起来,我建议您查看Log4j Audit描述的RequestContext。您不必使用Log4j Audit来实现这样的东西。它只是利用Log4j ThreadContext并定义所使用的特定密钥。然后初始化ThreadContext和请求开头的值,并在请求结束时清除它。您可以根据需要将项目添加到ThreadContext中。然后可以将Log4j配置为在每个日志事件中包括特定密钥。

我应该注意到,Spring Cloud Sleuth正在做一些我多年来一直在做的事情。要将请求信息从一个服务传播到下一个服务,只需在调用服务和启动服务时将其转换为HTTP头和从HTTP头转换为HTTP信息即可。这就是为什么Log4j Audit示例RequestContext显示了将属性分类为ClientServer、Local或Chained的注释。然后,它提供了实现这一目标所需的组件。

您可以使用spring-sleuth和日志过滤器来记录端点。检查Spring Sleuth文档;

https://docs.spring.io/spring-cloud-sleuth/docs/2.2.4.RELEASE/reference/html/

您可以创建一个过滤器来记录每个端点,或者记录其中一个端点。

有了这个记录器,你可以记录你想要的类型。

最新更新