日志链路追踪

Posted 2021-06-27 supingemail

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了日志链路追踪相关的知识，希望对你有一定的参考价值。

好记忆不如烂笔头，能记下点东西，就记下点，有时间拿出来看看，也会发觉不一样的感受。

一、前言

在日常工作中，我们需要经常处理业务的各种异常，而日志成了我们定位问题，解决问题最有效的绝佳手段。那么如何快速定位问题，并且解决问题呐？
下面说一下：针对链路上问题的排查，采用的一些方法和手段，供参考。

在日志输出上，现在最常用的是：logback(spring-boot 自带的日志体系) 和 log4j2两种日志的实现方式 ,不管采用那种实现手段，都是实现了Slf4j定义的日志接口，这里不做赘述。

在业务系统中，打印日志通常是使用@Slf4j注解的方式来操作（简单易用，方便维护），而不采用new XXX的方式来实现。

二、思路

如何快准精的在日志文件中，找到我们需要的日志信息呐？做法是：规范日志，即：定义一个日志对象 LogObject,在也业务中打印日志通过构建 LogObject，然后将 LogObject 进行输出，进而得到日志的详细信息。

LogObject 的定义如下：


import com.fasterxml.jackson.annotation.JsonProperty;


public final class LogObject {
	/**
	 * 系统的ID
	 */
	@JsonProperty(index = 1)
	private String sysId;
	/**
	 * 系统的名称
	 */
	@JsonProperty(index = 2)
	private String sysName;
	/**
	 * 事件名称,一般就是业务方法名称
	 */
	@JsonProperty(index = 3)
	private String eventName;
	/**
	 * 调用链ID
	 */
	@JsonProperty(index = 4)
	private String traceId;
	/**
	 * 结果消息
	 */
	@JsonProperty(index = 5)
	private String message;
	/**
	 * 接口响应时间
	 */
	@JsonProperty(index = 6)
	private long costTime;
	/**
	 * C端用户id
	 */
	@JsonProperty(index = 7)
	private Integer userId;
	/**
	 * 其他业务参数
	 */
	@JsonProperty(index = 8)
	private Object others;
	/**
	 * 请求参数
	 */
	@JsonProperty(index = 9)
	private Object request;
	/**
	 * 相应结果
	 */
	@JsonProperty(index = 10)
	private Object response;
	
	public LogObject() {
	}
	
	public LogObject(String sysId, String sysName, String eventName, String traceId, String message, long costTime, Integer userId, Object others, Object request, Object response) {
		this.sysId = sysId;
		this.sysName = sysName;
		this.eventName = eventName;
		this.traceId = traceId;
		this.message = message;
		this.costTime = costTime;
		this.userId = userId;
		this.others = others;
		this.request = request;
		this.response = response;
	}
	
	public String getSysId() {
		return sysId;
	}
	
	public void setSysId(String sysId) {
		this.sysId = sysId;
	}
	
	public String getSysName() {
		return sysName;
	}
	
	public void setSysName(String sysName) {
		this.sysName = sysName;
	}
	
	public String getEventName() {
		return eventName;
	}
	
	public void setEventName(String eventName) {
		this.eventName = eventName;
	}
	
	public String getTraceId() {
		return traceId;
	}
	
	public void setTraceId(String traceId) {
		this.traceId = traceId;
	}
	
	public String getMessage() {
		return message;
	}
	
	public void setMessage(String message) {
		this.message = message;
	}
	
	public long getCostTime() {
		return costTime;
	}
	
	public void setCostTime(long costTime) {
		this.costTime = costTime;
	}
	
	public Integer getUserId() {
		return userId;
	}
	
	public void setUserId(Integer userId) {
		this.userId = userId;
	}
	
	public Object getOthers() {
		return others;
	}
	
	public void setOthers(Object others) {
		this.others = others;
	}
	
	public Object getRequest() {
		return request;
	}
	
	public void setRequest(Object request) {
		this.request = request;
	}
	
	public Object getResponse() {
		return response;
	}
	
	public void setResponse(Object response) {
		this.response = response;
	}
}

在业务中，通过给对象复杂而后进行输出，就可以将链上的每一步业务操作追踪清楚。

此处实例，调用省略。