com.alipay.common.tracer.core.span

类 SofaTracerSpan

java.lang.Object

com.alipay.common.tracer.core.span.SofaTracerSpan

所有已实现的接口:

io.opentracing.Span, Closeable, AutoCloseable

直接已知子类:

CommonLogSpan

public class SofaTracerSpan
extends Object
implements io.opentracing.Span

SofaTracerSpan

从以下版本开始:

2017/06/17

作者:

yangguanchao

字段概要

字段

限定符和类型	字段和说明
static char	ARRAY_SEPARATOR

构造器概要

构造器

构造器和说明
SofaTracerSpan(SofaTracer sofaTracer, long startTime, List<SofaTracerSpanReferenceRelationship> spanReferences, String operationName, SofaTracerSpanContext sofaTracerSpanContext, Map<String,?> tags) 注意: 1.作为服务端:还原回 SofaTracerSpanContext 之后,就可以直接构造 Server Span(traceId,spanId 不变) 2.作为客户端:需要通过 构建
SofaTracerSpan(SofaTracer sofaTracer, long startTime, String operationName, SofaTracerSpanContext sofaTracerSpanContext, Map<String,?> tags) 作为服务端:还原回 SofaTracerSpanContext 之后,就可以直接构造 Server Span(traceId,spanId 不变)

方法概要

方法

限定符和类型	方法和说明
SofaTracerSpan	cloneInstance()
void	close()
io.opentracing.SpanContext	context()
void	finish()
void	finish(long endTime)
String	getBaggageItem(String key) 默认设置和读取的都是业务 baggage
long	getDurationMicroseconds()
long	getEndTime()
List<LogData>	getLogs()
String	getLogType()
String	getOperationName()
SofaTracerSpan	getParentSofaTracerSpan()
SofaTracer	getSofaTracer()
SofaTracerSpanContext	getSofaTracerSpanContext()
List<SofaTracerSpanReferenceRelationship>	getSpanReferences()
long	getStartTime()
Map<String,Boolean>	getTagsWithBool()
Map<String,Number>	getTagsWithNumber()
Map<String,String>	getTagsWithStr()
SofaTracerSpan	getThisAsParentWhenExceedLayer() 返回自身作为下一个上下文的 parent 采用 countMatches 来对 .
boolean	isClient()
boolean	isServer()
io.opentracing.Span	log(LogData logData)
io.opentracing.Span	log(long currentTime, Map<String,?> map)
io.opentracing.Span	log(long currentTime, String eventValue)
io.opentracing.Span	log(long currentTime, String eventName, Object payload)
io.opentracing.Span	log(Map<String,?> map)
io.opentracing.Span	log(String eventValue)
io.opentracing.Span	log(String eventName, Object payload)
void	profile(String profileApp, String protocolType, String profileMessage) 打印 Common Profile 日志
void	reportError(String errorType, Map<String,String> context, Throwable e, String errorSourceApp, String... errorSources)
io.opentracing.Span	setBaggageItem(String key, String value) 默认设置和读取的都是业务 baggage
void	setEndTime(long endTime)
void	setLogType(String logType)
io.opentracing.Span	setOperationName(String operationName)
void	setParentSofaTracerSpan(SofaTracerSpan parentSofaTracerSpan)
void	setStartTime(long startTime)
io.opentracing.Span	setTag(String key, boolean value)
io.opentracing.Span	setTag(String key, Number number)
io.opentracing.Span	setTag(String key, String value)
String	toString()

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

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

字段详细资料

ARRAY_SEPARATOR

public static final char ARRAY_SEPARATOR

另请参阅:

常量字段值

构造器详细资料

SofaTracerSpan

public SofaTracerSpan(SofaTracer sofaTracer,
              long startTime,
              String operationName,
              SofaTracerSpanContext sofaTracerSpanContext,
              Map<String,?> tags)

作为服务端:还原回 SofaTracerSpanContext 之后,就可以直接构造 Server Span(traceId,spanId 不变)

参数:

sofaTracer - sofaTracer 当前具体中间件 tracer

startTime - 开始时间

operationName - 操作名称

sofaTracerSpanContext - 当前上下文信息

tags - 标签

SofaTracerSpan

public SofaTracerSpan(SofaTracer sofaTracer,
              long startTime,
              List<SofaTracerSpanReferenceRelationship> spanReferences,
              String operationName,
              SofaTracerSpanContext sofaTracerSpanContext,
              Map<String,?> tags)

注意: 1.作为服务端:还原回 SofaTracerSpanContext 之后,就可以直接构造 Server Span(traceId,spanId 不变) 2.作为客户端:需要通过 构建

参数:

sofaTracer - 当前 tracer

startTime - 开始时间

spanReferences - 引用关系

operationName - 操作名称

sofaTracerSpanContext - 当前上下文

tags - 标签

方法详细资料

cloneInstance

public SofaTracerSpan cloneInstance()

context

public io.opentracing.SpanContext context()

指定者:

context 在接口中 io.opentracing.Span

finish

public void finish()

指定者:

finish 在接口中 io.opentracing.Span

finish

public void finish(long endTime)

指定者:

finish 在接口中 io.opentracing.Span

close

public void close()

指定者:

close 在接口中 io.opentracing.Span

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

setTag

public io.opentracing.Span setTag(String key,
                         String value)

指定者:

setTag 在接口中 io.opentracing.Span

setTag

public io.opentracing.Span setTag(String key,
                         boolean value)

指定者:

setTag 在接口中 io.opentracing.Span

setTag

public io.opentracing.Span setTag(String key,
                         Number number)

指定者:

setTag 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(String eventValue)

指定者:

log 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(long currentTime,
                      String eventValue)

指定者:

log 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(LogData logData)

log

public io.opentracing.Span log(long currentTime,
                      Map<String,?> map)

指定者:

log 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(Map<String,?> map)

指定者:

log 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(String eventName,
                      Object payload)

指定者:

log 在接口中 io.opentracing.Span

log

public io.opentracing.Span log(long currentTime,
                      String eventName,
                      Object payload)

指定者:

log 在接口中 io.opentracing.Span

setBaggageItem

public io.opentracing.Span setBaggageItem(String key,
                                 String value)

默认设置和读取的都是业务 baggage

指定者:

setBaggageItem 在接口中 io.opentracing.Span

参数:

key - 关键字

value - 值

返回:

当前 span

getBaggageItem

public String getBaggageItem(String key)

默认设置和读取的都是业务 baggage

指定者:

getBaggageItem 在接口中 io.opentracing.Span

参数:

key - 关键字

返回:

当前 span

setOperationName

public io.opentracing.Span setOperationName(String operationName)

指定者:

setOperationName 在接口中 io.opentracing.Span

reportError

public void reportError(String errorType,
               Map<String,String> context,
               Throwable e,
               String errorSourceApp,
               String... errorSources)

参数:

errorType - errorType error 描述:timeout_error/biz_error...

context - context 记录的上下文信息

e - e 异常信息

errorSourceApp - errorSources 故障源 trade|rpc

errorSources - errorSources 故障源数组

profile

public void profile(String profileApp,
           String protocolType,
           String profileMessage)

打印 Common Profile 日志

参数:

profileApp - profile 应用

protocolType - 协议类型

profileMessage - 日志内容

getThisAsParentWhenExceedLayer

public SofaTracerSpan getThisAsParentWhenExceedLayer()

返回自身作为下一个上下文的 parent

采用 countMatches 来对 . 进行计数, 以获取更高的性能, 见com.alipay.common.tracer.benchmark.CountBenchmark 的性能测试数据 防止 SofaTracerSpan 嵌套过深导致内存泄漏。这个时候重新创建一个上下文，使上面的上下文都能够释放。

返回:

重新构造的 span

getSpanReferences

public List<SofaTracerSpanReferenceRelationship> getSpanReferences()

getSofaTracer

public SofaTracer getSofaTracer()

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long startTime)

getEndTime

public long getEndTime()

setEndTime

public void setEndTime(long endTime)

getDurationMicroseconds

public long getDurationMicroseconds()

getTagsWithStr

public Map<String,String> getTagsWithStr()

getTagsWithBool

public Map<String,Boolean> getTagsWithBool()

getTagsWithNumber

public Map<String,Number> getTagsWithNumber()

getOperationName

public String getOperationName()

getSofaTracerSpanContext

public SofaTracerSpanContext getSofaTracerSpanContext()

getLogs

public List<LogData> getLogs()

getLogType

public String getLogType()

setLogType

public void setLogType(String logType)

getParentSofaTracerSpan

public SofaTracerSpan getParentSofaTracerSpan()

setParentSofaTracerSpan

public void setParentSofaTracerSpan(SofaTracerSpan parentSofaTracerSpan)

isServer

public boolean isServer()

isClient

public boolean isClient()

toString

public String toString()

覆盖:

toString 在类中 Object