com.taobao.eagleeye

类 RpcContext_inner

java.lang.Object

com.taobao.eagleeye.RpcContext_inner

public final class RpcContext_inner
extends Object

RPC 调用上下文

从以下版本开始:

1.5.0-exported

方法概要

方法

限定符和类型	方法和说明
RpcContext_inner	createChildRpc() 创建子 RPC 上下文
void	endLocal(String bizResultCode, String appendMsg) 本地调用结束，并设置业务状态码。
void	endLocal(String resultCode, String bizResultCode, String appendMsg) 本地调用结束
void	endRpc(String result, int type, String appendMsg)
void	endTrace(String resultCode, int type)
String	exportPrintableUserData() 导出需要透传的 UserData, 导出的形式为可打印的字符 类似于 URL ?
String	exportUserData() 导出需要透传的 UserData
Object	getAttachment(String key)
Map<String,Object>	getAttachmentMap()
String	getCallBackMsg()
String	getLocalAttribute(String key)
Map<String,String>	getLocalAttributeMap()
String	getLocalId()
long	getLogTime()
String	getMethodName()
RpcContext_inner	getParentRpcContext() 获取上一层调用上下文
String	getRemoteIp()
long	getRequestSize()
long	getResponseSize()
String	getRpcId()
int	getRpcType()
String	getServiceName()
long	getStartTime()
int	getTimeSpan0()
int	getTimeSpan1()
String	getTraceId()
String	getTraceName()
String	getUserData(String key)
Map<String,String>	getUserDataMap()
void	importPrintableUserData(String userData) 导入透传过来的 UserData (类似于 URL ?
void	importUserData(String userData) 导入透传过来的 UserData
void	index(int type, String index, String msg)
boolean	isLocalContextActive() 用于判断当前 LocalContext 是否处于激活状态（栈顶）
boolean	isTraceSampled() 检查当前上下文是否被采样，有效范围在 [1, 9999] 之间，超出范围的数值都作为全采样处理。
boolean	isTraceSampled(int samplingInterval) 检查当前上下文是否被采样，有效范围在 [1, 9999] 之间，超出范围的数值都作为全采样处理。
Object	putAttachment(String key, Object value)
String	putLocalAttribute(String key, String value)
String	putUserData(String key, String value)
void	putUserDataXX(String key, String value)
Object	removeAttachment(String key)
String	removeLocalAttribute(String key)
String	removeUserData(String key)
void	resetTraceName(String traceName, String iToken)
void	rpcClientSend()
void	rpcServerRecv(String serviceName, String methodName)
void	rpcServerSend(int type, String resultCode, String appendMsg)
void	setBizResultCode(String bizResultCode) 设置业务的状态码（不要有可变参数在里面，因为要进行统计）
void	setCallBackMsg(String callBackMsg)
void	setLogTime(long logTime)
void	setMethodName(String methodName)
void	setRemoteIp(String remoteIp)
void	setRequestSize(long requestSize)
void	setResponseSize(long responseSize)
void	setRpcType(int rpcType)
void	setServiceName(String serviceName)
void	setStartTime(long startTime)
void	setTimeSpan0(int span0)
void	setTimeSpan1(int span1)
void	startLocal(String serviceName, String methodName) 开始一次本地调用
void	startLocal(String componentType, String serviceName, String methodName) 开始一次本地调用
void	startRpc(String serviceName, String methodName)
void	startTrace(String traceName)
Map<String,String>	toMap() 把 RpcContext 导出为 Map 进行传输，以便网络传输时序列化可以兼容新老版本。

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

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

方法详细资料

startLocal

public void startLocal(String serviceName,
              String methodName)

开始一次本地调用

参数:

serviceName - 接口名称

methodName - 方法名称

startLocal

public void startLocal(String componentType,
              String serviceName,
              String methodName)

开始一次本地调用

参数:

componentType - 组件类型

serviceName - 接口名称

methodName - 方法名称

endLocal

public void endLocal(String bizResultCode,
            String appendMsg)

本地调用结束，并设置业务状态码。如果业务状态码不是 RPC_RESULT_SUCCESS ， 则认为设置的业务状态码是表示错误的业务状态码

参数:

bizResultCode - 设置业务状态码

appendMsg - 客户端日志追加的信息， 不能有回车换行等符号，可以为 null

endLocal

public void endLocal(String resultCode,
            String bizResultCode,
            String appendMsg)

本地调用结束

参数:

resultCode - 用于表明成功还是失败。 如果成功，使用RPC_RESULT_SUCCESS，如果失败，使用 RPC_RESULT_FAILED

bizResultCode - 业务的状态码（不要有可变参数在里面，因为要进行统计）

appendMsg - 客户端日志追加的信息， 不能有回车、换行、“|” 等符号

isLocalContextActive

public boolean isLocalContextActive()

用于判断当前 LocalContext 是否处于激活状态（栈顶）

createChildRpc

public RpcContext_inner createChildRpc()

创建子 RPC 上下文

返回:

getParentRpcContext

public RpcContext_inner getParentRpcContext()

获取上一层调用上下文

startTrace

public void startTrace(String traceName)

endTrace

public void endTrace(String resultCode,
            int type)

startRpc

public void startRpc(String serviceName,
            String methodName)

endRpc

public void endRpc(String result,
          int type,
          String appendMsg)

rpcClientSend

public void rpcClientSend()

rpcServerRecv

public void rpcServerRecv(String serviceName,
                 String methodName)

rpcServerSend

public void rpcServerSend(int type,
                 String resultCode,
                 String appendMsg)

resetTraceName

public void resetTraceName(String traceName,
                  String iToken)

putUserDataXX

public void putUserDataXX(String key,
                 String value)

index

public void index(int type,
         String index,
         String msg)

toMap

public Map<String,String> toMap()

把 RpcContext 导出为 Map 进行传输，以便网络传输时序列化可以兼容新老版本。

返回:

getLocalId

public String getLocalId()

getRequestSize

public long getRequestSize()

setRequestSize

public void setRequestSize(long requestSize)

getResponseSize

public long getResponseSize()

setResponseSize

public void setResponseSize(long responseSize)

getRemoteIp

public String getRemoteIp()

setRemoteIp

public void setRemoteIp(String remoteIp)

setStartTime

public void setStartTime(long startTime)

getStartTime

public long getStartTime()

setTimeSpan0

public void setTimeSpan0(int span0)

getTimeSpan0

public int getTimeSpan0()

setTimeSpan1

public void setTimeSpan1(int span1)

getTimeSpan1

public int getTimeSpan1()

setBizResultCode

public void setBizResultCode(String bizResultCode)

设置业务的状态码（不要有可变参数在里面，因为要进行统计）

参数:

bizResultCode -

isTraceSampled

public final boolean isTraceSampled()

检查当前上下文是否被采样，有效范围在 [1, 9999] 之间，超出范围的数值都作为全采样处理。

返回:

true 则需要输出日志，false 不输出

isTraceSampled

public final boolean isTraceSampled(int samplingInterval)

检查当前上下文是否被采样，有效范围在 [1, 9999] 之间，超出范围的数值都作为全采样处理。

参数:

samplingInterval -

返回:

true 则需要输出日志，false 不输出

putUserData

public String putUserData(String key,
                 String value)

removeUserData

public String removeUserData(String key)

getUserData

public String getUserData(String key)

getUserDataMap

public Map<String,String> getUserDataMap()

putLocalAttribute

public String putLocalAttribute(String key,
                       String value)

removeLocalAttribute

public String removeLocalAttribute(String key)

getLocalAttribute

public String getLocalAttribute(String key)

getLocalAttributeMap

public Map<String,String> getLocalAttributeMap()

putAttachment

public Object putAttachment(String key,
                   Object value)

removeAttachment

public Object removeAttachment(String key)

getAttachment

public Object getAttachment(String key)

getAttachmentMap

public Map<String,Object> getAttachmentMap()

exportUserData

public String exportUserData()

导出需要透传的 UserData

exportPrintableUserData

public String exportPrintableUserData()

导出需要透传的 UserData, 导出的形式为可打印的字符 类似于 URL ? 之后的参数: k1=v1&k2=v2& 适用于对明文协议(比如 HTTP)做埋点时导出 userData

importUserData

public void importUserData(String userData)

导入透传过来的 UserData

参数:

userData -

importPrintableUserData

public void importPrintableUserData(String userData)

导入透传过来的 UserData (类似于 URL ?之后的参数: k1=v1&k2=v2&) 注意: 此接口暂时没有对 & = 进行 escape 适用于导入明文协议(比如 HTTP)传递过来的 userData

参数:

userData -

getServiceName

public String getServiceName()

setServiceName

public void setServiceName(String serviceName)

getMethodName

public String getMethodName()

setMethodName

public void setMethodName(String methodName)

getLogTime

public long getLogTime()

setLogTime

public void setLogTime(long logTime)

getRpcType

public int getRpcType()

setRpcType

public void setRpcType(int rpcType)

getTraceId

public String getTraceId()

getRpcId

public String getRpcId()

getCallBackMsg

public String getCallBackMsg()

setCallBackMsg

public void setCallBackMsg(String callBackMsg)

getTraceName

public String getTraceName()