Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.dahua.eco.base.spring.http.log.TraceLogHelper Maven / Gradle / Ivy
package com.dahua.eco.base.spring.http.log;
import com.alibaba.fastjson.JSONObject;
import com.dahua.eco.base.spring.http.log.domain.LogContent;
import com.dahua.eco.base.spring.http.log.domain.SpanInfo;
import com.dahua.eco.base.spring.utils.UuidUtil;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.util.CollectionUtils;
import javax.servlet.http.HttpServletResponse;
import java.text.MessageFormat;
import java.util.List;
public class TraceLogHelper {
private static final ThreadLocal headLogHolder = new ThreadLocal();
// 请求头 traceId 属性名称
public static final String HEADER_NAME_TRACE_ID = "X-TraceID";
// 请求头 spanId 属性名称
public static final String HEADER_NAME_SPAN_ID = "X-SpanID";
// 请求头 ErrorCode 属性名称
public final static String HEADER_NAME_ERROR_CODE = "ErrorCode";
// 请求头 X-Forwarded-For 属性名称
public final static String HEADER_NAME_FORWARDED_FOR = "X-Forwarded-For";
// 请求头 User-Client 属性名称
public final static String HEADER_NAME_USER_CLIENT = "User-Client";
// 请求头 User-Id 属性名称
public final static String HEADER_NAME_USER_ID = "User-Id";
// 初始化 sequence
public static final String INIT_SEQUENCE_VALUE = "001";
// 跟踪日志输出对象
private static Logger traceLogger = LoggerFactory.getLogger("trace-logger");
private static Logger infoLogger = LoggerFactory.getLogger(TraceLogHelper.class);
/**
* 记录追踪日志
*
* @param content 日志内容
* @param args 占位符参数
*/
public static void recordTraceLog(String content, Object... args) {
traceLogger.info(content, args);
}
/**
* 记录追踪日志
* traceInfoList = httpHeaders.get(HEADER_NAME_TRACE_ID);
if (CollectionUtils.isEmpty(traceInfoList) || StringUtils.isEmpty(traceInfoList.get(0))) {
if (requestTraceInfo == null) {
requestTraceInfo = generateNewTraceInfo();
}
httpHeaders.add(HEADER_NAME_TRACE_ID, requestTraceInfo.getTraceString());
headLogHolder.set(httpHeaders);
return requestTraceInfo;
} else {
String traceIdString = traceInfoList.get(0);
headLogHolder.set(httpHeaders);
return TraceLogParser.getTraceInfo(traceIdString);
}
}
/**
* @Title: addSpanInfo2Header
* @Description: 添加日志追踪信息到请求中如果 header 中已经有 span-info，则直接返回，如果没有，优先使用参数中传入的 requestSpanInfo，如为空，则创建新的
* @param @param httpHeaders
* @param @param requestSpanInfo
* @param @return 设定文件
* @return SpanInfo 返回类型
* @throws
*/
public static SpanInfo addSpanInfo2Header(HttpHeaders httpHeaders, SpanInfo requestSpanInfo) {
// 请求头中没有 spanId，则创建新的
if (httpHeaders == null||null==httpHeaders.get(HEADER_NAME_SPAN_ID)) {
httpHeaders = headLogHolder.get();
if(httpHeaders==null) {
httpHeaders = new HttpHeaders();
}
}
List spanInfoList = httpHeaders.get(HEADER_NAME_SPAN_ID);
if (CollectionUtils.isEmpty(spanInfoList) || StringUtils.isEmpty(spanInfoList.get(0))) {
if (requestSpanInfo == null) {
requestSpanInfo = generateNewSpanInfo();
}
httpHeaders.add(HEADER_NAME_SPAN_ID, JSONObject.toJSONString(requestSpanInfo));
headLogHolder.set(httpHeaders);
return requestSpanInfo;
} else {// 如果请求头中有老的spanId则生成新spanid将老的放入pSpanId中
String spanIdString = spanInfoList.get(0);
SpanInfo spanInfo= TraceLogParser.getSpanInfo(spanIdString);
// String newSpanId = UuidUtil.generateUUID();
// SpanInfo nextSpanInfo = TraceLogHelper.generateNextSpanTag(spanInfo, newSpanId);
// if (nextSpanInfo == null) { // 生成失败，则不做spanId的更新
// nextSpanInfo = spanInfo;
// }
headLogHolder.set(httpHeaders);
return spanInfo;
}
}
/**
* 从 header 中获取日志追踪信息
*
* @param httpHeaders
*/
public static TraceInfo getTraceInfoFromHeader(HttpHeaders httpHeaders) {
if (httpHeaders != null) {
List values = httpHeaders.get(HEADER_NAME_ERROR_CODE);
if (!CollectionUtils.isEmpty(values)) {
return TraceLogParser.getTraceInfo(values.get(0));
}
}
return null;
}
/**
* 添加错误编码到响应中
*
* @param errorCode
* @param response
*/
public static void addErrorCode2Response(String errorCode, HttpServletResponse response) {
if (StringUtils.isEmpty(errorCode)) {
return;
}
if (response != null) {
response.setHeader(HEADER_NAME_ERROR_CODE, errorCode);
}
}
/**
* 从响应中获取错误编码
*
* @param response
*/
public static String getErrorCodeFromResponse(HttpServletResponse response) {
if (response != null) {
return response.getHeader(HEADER_NAME_ERROR_CODE);
}
return "";
}
/**
* @Title: getLocalThreadLogHead
* @Description: 获得线程内的请求头（内含请求头 traceId和 spanId信息如果空则没有被生成过）
* @param @return 设定文件
* @return HttpHeaders 返回类型
* @throws
*/
public static HttpHeaders getLocalThreadLogHead() {
return headLogHolder.get();
}
/**
* @Title: setLocalThreadLogHead
* @Description: 设置线程内的请求头（内含请求头 traceId和 spanId信息如果空则没有被生成过）
* @param @param httpHeaders 设定文件
* @return void 返回类型
* @throws
*/
public static void setLocalThreadLogHead(HttpHeaders httpHeaders) {
headLogHolder.set(httpHeaders);
}
/**
* @Title: removeLocalThreadLogHead
* @Description: TODO方法描述:(这里用一句话描述这个方法的作用)
* @param 设定文件
* @return void 返回类型
* @throws
*/
public static void removeLocalThreadLogHead() {
headLogHolder.remove();
}
}
