com.taobao.eagleeye

类 EagleEyeRequestTracer

java.lang.Object

com.taobao.eagleeye.EagleEyeRequestTracer

public class EagleEyeRequestTracer
extends Object

抽离和前端相关的 EagleEye 通用埋点逻辑。 支持从 URL/Header 中获取 EagleEye 的配置。 常见埋点方法：

 String traceId = EagleEyeRequestTracer.getTraceId(httpRequest);
 EagleEyeRequestTracer.startTrace(traceId, req, resp);
 try {
   // 处理业务逻辑...
   chain.doFilter(req, resp);
 } finally {
   EagleEyeRequestTracer.endTrace(req, resp);
 }
 

startTrace 调用后，一定要保证调用一次 endTrace。 startTrace 和 endTrace 是幂等的，重复调用不会影响逻辑。 如果没有调用 startTrace，直接调用 endTrace，也是可以的。

从以下版本开始:

1.5.0-exported

构造器概要

构造器

构造器和说明
EagleEyeRequestTracer()

方法概要

方法

限定符和类型	方法和说明
static void	endTrace(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) 结束调用链。
static void	endTrace(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String resultCode, int type) 结束调用链，设置响应状态码和调用类型。
static String	getRemoteAddress(javax.servlet.http.HttpServletRequest request) 获取远程客户端的 IP
static String	getTraceId(javax.servlet.http.HttpServletRequest request) 获取 TraceId，如果没有，自动生成。
static String	getTraceId(javax.servlet.http.HttpServletRequest httpRequest, String ip) 获取 TraceId。
static void	startTrace(String traceId, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) 开始调用链，注意，开始之后，不管后续处理是否正常，都需要调用 endTrace(HttpServletRequest, HttpServletResponse)。
static void	startTraceInner(String traceId, String rpcId, String url, String queryString, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) 开始调用链，允许另外指定 TraceId、RpcId、URL、Query 参数等信息。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

EagleEyeRequestTracer

public EagleEyeRequestTracer()

方法详细资料

getRemoteAddress

public static final String getRemoteAddress(javax.servlet.http.HttpServletRequest request)

获取远程客户端的 IP

参数:

request -

返回:

getTraceId

public static final String getTraceId(javax.servlet.http.HttpServletRequest request)

获取 TraceId，如果没有，自动生成。

参数:

request -

返回:

另请参阅:

getTraceId(HttpServletRequest, String)

getTraceId

public static final String getTraceId(javax.servlet.http.HttpServletRequest httpRequest,
                String ip)

获取 TraceId。根据以下步骤：

1. 从 ThreadLocal 获取
2. 从 URL 参数中 获取
3. 从 header 中 获取
4. 如果上述都没有，则自动生成，如果 ip 不为 null，则基于指定的 ip， 否则，使用本机 ip

参数:

httpRequest -

ip -

startTrace

public static final void startTrace(String traceId,
              javax.servlet.http.HttpServletRequest httpRequest,
              javax.servlet.http.HttpServletResponse httpResponse)

开始调用链，注意，开始之后，不管后续处理是否正常，都需要调用 endTrace(HttpServletRequest, HttpServletResponse)。

参数:

traceId -

httpRequest -

httpResponse -

startTraceInner

public static final void startTraceInner(String traceId,
                   String rpcId,
                   String url,
                   String queryString,
                   javax.servlet.http.HttpServletRequest httpRequest,
                   javax.servlet.http.HttpServletResponse httpResponse)

开始调用链，允许另外指定 TraceId、RpcId、URL、Query 参数等信息。注意，开始之后，不管后续处理是否正常， 都需要调用 endTrace(HttpServletRequest, HttpServletResponse)。

参数:

traceId -

url -

queryString -

httpRequest -

httpResponse -

endTrace

public static final void endTrace(javax.servlet.http.HttpServletRequest httpRequest,
            javax.servlet.http.HttpServletResponse httpResponse)

结束调用链。 注意：需要假定 response 已经提交，因此只能做只读操作，不能修改

参数:

httpRequest -

httpResponse -

endTrace

public static final void endTrace(javax.servlet.http.HttpServletRequest httpRequest,
            javax.servlet.http.HttpServletResponse httpResponse,
            String resultCode,
            int type)

结束调用链，设置响应状态码和调用类型。 注意：需要假定 response 已经提交，因此只能做只读操作，不能修改

参数:

httpRequest -

httpResponse -

resultCode - 建议使用 HTTP 状态码

type -