类 com.alipay.common.tracer.core.span.SofaTracerSpan
的使用

使用SofaTracerSpan的程序包

程序包	说明
com.alipay.common.tracer.core
com.alipay.common.tracer.core.appender.manager
com.alipay.common.tracer.core.context.trace
com.alipay.common.tracer.core.listener
com.alipay.common.tracer.core.reporter.composite
com.alipay.common.tracer.core.reporter.digest
com.alipay.common.tracer.core.reporter.facade
com.alipay.common.tracer.core.reporter.stat
com.alipay.common.tracer.core.span
com.alipay.common.tracer.core.tracer
com.alipay.common.tracer.core.utils

com.alipay.common.tracer.core中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core中的方法

限定符和类型	方法和说明
void	SofaTracer.reportSpan(SofaTracerSpan span)

com.alipay.common.tracer.core.appender.manager中SofaTracerSpan的使用

返回SofaTracerSpan的com.alipay.common.tracer.core.appender.manager中的方法

限定符和类型	方法和说明
SofaTracerSpan	SofaTracerSpanEvent.getSofaTracerSpan() Getter method for property sofaTracerSpan.

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.appender.manager中的方法

限定符和类型	方法和说明
boolean	AsyncCommonDigestAppenderManager.append(SofaTracerSpan sofaTracerSpan)
void	SofaTracerSpanEvent.setSofaTracerSpan(SofaTracerSpan sofaTracerSpan) Setter method for property sofaTracerSpan.

com.alipay.common.tracer.core.context.trace中SofaTracerSpan的使用

返回SofaTracerSpan的com.alipay.common.tracer.core.context.trace中的方法

限定符和类型	方法和说明
SofaTracerSpan	SofaTracerThreadLocalTraceContext.getCurrentSpan()
SofaTracerSpan	SofaTraceContext.getCurrentSpan() Retrieves the current span without modifying the TraceContext
SofaTracerSpan	SofaTracerThreadLocalTraceContext.pop()
SofaTracerSpan	SofaTraceContext.pop() Removes a span from the TraceContext

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.context.trace中的方法

限定符和类型	方法和说明
void	SofaTracerThreadLocalTraceContext.push(SofaTracerSpan span)
void	SofaTraceContext.push(SofaTracerSpan span) Adds the given span to the TraceContext if the span is null ,then ignore pushed

com.alipay.common.tracer.core.listener中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.listener中的方法

限定符和类型	方法和说明
void	SpanReportListener.onSpanReport(SofaTracerSpan sofaTracerSpan)

com.alipay.common.tracer.core.reporter.composite中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.reporter.composite中的方法

限定符和类型	方法和说明
void	SofaTracerCompositeDigestReporterImpl.doReport(SofaTracerSpan span)

com.alipay.common.tracer.core.reporter.digest中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.reporter.digest中的方法

限定符和类型	方法和说明
void	DiskReporterImpl.digestReport(SofaTracerSpan span)
abstract void	AbstractDiskReporter.digestReport(SofaTracerSpan span) 打印摘要日志
void	AbstractDiskReporter.doReport(SofaTracerSpan span) 输出 span
protected boolean	AbstractDiskReporter.isDisableDigestLog(SofaTracerSpan span)
void	DiskReporterImpl.statisticReport(SofaTracerSpan span)
abstract void	AbstractDiskReporter.statisticReport(SofaTracerSpan span) 打印统计日志

com.alipay.common.tracer.core.reporter.facade中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.reporter.facade中的方法

限定符和类型	方法和说明
abstract void	AbstractReporter.doReport(SofaTracerSpan span) 抽象方法具体输出方式落磁盘还会远程上报需要子类实现
void	Reporter.report(SofaTracerSpan span) 输出 span
void	AbstractReporter.report(SofaTracerSpan span) 输出 span

com.alipay.common.tracer.core.reporter.stat中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.reporter.stat中的方法

限定符和类型	方法和说明
abstract void	AbstractSofaTracerStatisticReporter.doReportStat(SofaTracerSpan sofaTracerSpan) 执行统计操作,并调用 AbstractSofaTracerStatisticReporter.addStat(com.alipay.common.tracer.core.reporter.stat.model.StatKey, long...)
void	SofaTracerStatisticReporter.reportStat(SofaTracerSpan sofaTracerSpan) 向槽中更新数据 前面是唯一的key，后面是数值列 统计计算会对不同key的数值列进行加和
void	AbstractSofaTracerStatisticReporter.reportStat(SofaTracerSpan sofaTracerSpan)

com.alipay.common.tracer.core.span中SofaTracerSpan的使用

com.alipay.common.tracer.core.span中SofaTracerSpan的子类

限定符和类型	类和说明
class	CommonLogSpan CommonLogSpan 主要为了记录具体的顺序数据 之所以要新创建一个对象，主要是为了区分 CommonLogSpan 和日常摘要等的打印 com.alipay.common.tracer.core.span.LogData#EVENT_COMMON_TYPE_VALUE

返回SofaTracerSpan的com.alipay.common.tracer.core.span中的方法

限定符和类型	方法和说明
SofaTracerSpan	SofaTracerSpan.cloneInstance()
SofaTracerSpan	SofaTracerSpan.getParentSofaTracerSpan()
SofaTracerSpan	SofaTracerSpan.getThisAsParentWhenExceedLayer() 返回自身作为下一个上下文的 parent 采用 countMatches 来对 .

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.span中的方法

限定符和类型	方法和说明
void	SofaTracerSpan.setParentSofaTracerSpan(SofaTracerSpan parentSofaTracerSpan)

com.alipay.common.tracer.core.tracer中SofaTracerSpan的使用

返回SofaTracerSpan的com.alipay.common.tracer.core.tracer中的方法

限定符和类型	方法和说明
SofaTracerSpan	AbstractTracer.clientSend(String operationName) 注意:生成的 Span 未放入线程上下文中 在发生一次网络调用之前。
protected SofaTracerSpan	AbstractTracer.errorRecover(Map<String,String> bizBaggage, Map<String,String> sysBaggage) 当发生错误进行补救,从根节点重新计数开始
protected SofaTracerSpan	AbstractTracer.genSeverSpanInstance(long startTime, String operationName, SofaTracerSpanContext sofaTracerSpanContext, Map<String,?> tags)
SofaTracerSpan	AbstractTracer.serverReceive() 收到请求
SofaTracerSpan	AbstractTracer.serverReceive(SofaTracerSpanContext sofaTracerSpanContext) 收到请求

返回变量类型为SofaTracerSpan的类型的com.alipay.common.tracer.core.tracer中的方法

限定符和类型	方法和说明
protected abstract SpanEncoder<SofaTracerSpan>	AbstractTracer.getClientDigestEncoder()
protected SpanEncoder<SofaTracerSpan>	AbstractServerTracer.getClientDigestEncoder()
protected abstract SpanEncoder<SofaTracerSpan>	AbstractTracer.getServerDigestEncoder()
protected SpanEncoder<SofaTracerSpan>	AbstractClientTracer.getServerDigestEncoder()

类型变量类型为SofaTracerSpan的com.alipay.common.tracer.core.tracer中的方法参数

限定符和类型	方法和说明
protected Reporter	AbstractTracer.generateReporter(AbstractSofaTracerStatisticReporter statReporter, String logName, String logRollingKey, String logNameKey, SpanEncoder<SofaTracerSpan> spanEncoder)

com.alipay.common.tracer.core.utils中SofaTracerSpan的使用

参数类型为SofaTracerSpan的com.alipay.common.tracer.core.utils中的方法

限定符和类型	方法和说明
static boolean	TracerUtils.checkBaggageLength(SofaTracerSpan sofaTracerSpan, String key, String value)
static String	TracerUtils.getLoadTestMark(SofaTracerSpan span)
static boolean	TracerUtils.isLoadTest(SofaTracerSpan sofaTracerSpan)