com.alipay.common.tracer.core.reporter.stat

类 AbstractSofaTracerStatisticReporter

java.lang.Object

com.alipay.common.tracer.core.reporter.stat.AbstractSofaTracerStatisticReporter

所有已实现的接口:

SofaTracerStatisticReporter

public abstract class AbstractSofaTracerStatisticReporter
extends Object
implements SofaTracerStatisticReporter

AbstractSofaTracerStatisticReporter

从以下版本开始:

2017/06/26

作者:

yangguanchao

字段概要

字段

限定符和类型	字段和说明
protected TraceAppender	appender 输出器
static int	DEFAULT_CYCLE 默认的周期为0(从0开始)，即输出间隔时间是一个周期时间（一个周期多长时间是可以设置的，默认是60s）, SofaTracerStatisticReporterManager.DEFAULT_CYCLE_SECONDS
protected AtomicBoolean	isClosePrint 是否关闭统计日志打印,默认不关闭
protected Map<StatKey,StatValues>	statDatas 统计数据
protected String	statTracerName 统计日志的名称

构造器概要

构造器

构造器和说明
AbstractSofaTracerStatisticReporter(String statTracerName, long periodTime, int outputCycle, String rollingPolicy, String logReserveConfig)
AbstractSofaTracerStatisticReporter(String statTracerName, String rollingPolicy, String logReserveConfig)

方法概要

方法

限定符和类型	方法和说明
protected void	addStat(StatKey keys, long... values) 默认只提供累加的统计方法 向槽中更新数据 前面是唯一的key，后面是数值列 统计计算会对不同key的数值列进行加和
protected String	buildString(String[] keys)
void	close() 关闭打印能力
abstract void	doReportStat(SofaTracerSpan sofaTracerSpan) 执行统计操作,并调用 addStat(com.alipay.common.tracer.core.reporter.stat.model.StatKey, long...)
AtomicBoolean	getIsClosePrint()
Map<StatKey,StatValues>	getOtherStatData() 获取另一组非当前正在统计的数据,总共:两组数据进行统计和打印
long	getPeriodTime() 获取周期时间,即多长时间调度一次
Map<StatKey,StatValues>	getStatData() 返回当前被统计的数据
String	getStatTracerName() 获取统计类型额唯一标示
void	print(StatKey statKey, long[] values) 打印,即可以打印到本地磁盘,也可以上报到远程服务器
void	reportStat(SofaTracerSpan sofaTracerSpan) 向槽中更新数据 前面是唯一的key，后面是数值列 统计计算会对不同key的数值列进行加和
void	setIsClosePrint(AtomicBoolean isClosePrint)
Map<StatKey,StatValues>	shiftCurrentIndex() 切换当前下标并返回切换前的统计数据
boolean	shouldPrintNow() 当该方法被调用，说明已经过去了一个周期，要判断是否已经过去了足够的周期，是否需要flush

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

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

字段详细资料

DEFAULT_CYCLE

public static final int DEFAULT_CYCLE

默认的周期为0(从0开始)，即输出间隔时间是一个周期时间（一个周期多长时间是可以设置的，默认是60s）, SofaTracerStatisticReporterManager.DEFAULT_CYCLE_SECONDS

另请参阅:

常量字段值

isClosePrint

protected AtomicBoolean isClosePrint

是否关闭统计日志打印,默认不关闭

appender

protected TraceAppender appender

输出器

statTracerName

protected String statTracerName

统计日志的名称

statDatas

protected Map<StatKey,StatValues> statDatas

统计数据

构造器详细资料

AbstractSofaTracerStatisticReporter

public AbstractSofaTracerStatisticReporter(String statTracerName,
                                   String rollingPolicy,
                                   String logReserveConfig)

AbstractSofaTracerStatisticReporter

public AbstractSofaTracerStatisticReporter(String statTracerName,
                                   long periodTime,
                                   int outputCycle,
                                   String rollingPolicy,
                                   String logReserveConfig)

方法详细资料

getPeriodTime

public long getPeriodTime()

从接口复制的说明: SofaTracerStatisticReporter

获取周期时间,即多长时间调度一次

指定者:

getPeriodTime 在接口中 SofaTracerStatisticReporter

返回:

一次统计数据的周期时间

getStatTracerName

public String getStatTracerName()

从接口复制的说明: SofaTracerStatisticReporter

获取统计类型额唯一标示

指定者:

getStatTracerName 在接口中 SofaTracerStatisticReporter

返回:

统计名称(全局唯一标识)

reportStat

public void reportStat(SofaTracerSpan sofaTracerSpan)

从接口复制的说明: SofaTracerStatisticReporter

向槽中更新数据 前面是唯一的key，后面是数值列 统计计算会对不同key的数值列进行加和

指定者:

reportStat 在接口中 SofaTracerStatisticReporter

参数:

sofaTracerSpan - span 上下文

doReportStat

public abstract void doReportStat(SofaTracerSpan sofaTracerSpan)

执行统计操作,并调用 addStat(com.alipay.common.tracer.core.reporter.stat.model.StatKey, long...)

参数:

sofaTracerSpan - 要被统计的 span

addStat

protected void addStat(StatKey keys,
           long... values)

默认只提供累加的统计方法 向槽中更新数据 前面是唯一的key，后面是数值列 统计计算会对不同key的数值列进行加和

参数:

keys - 被统计 key 的唯一标示

values - 被统计的值

shiftCurrentIndex

public Map<StatKey,StatValues> shiftCurrentIndex()

切换当前下标并返回切换前的统计数据

指定者:

shiftCurrentIndex 在接口中 SofaTracerStatisticReporter

返回:

当前时间段内的统计数据

getStatData

public Map<StatKey,StatValues> getStatData()

返回当前被统计的数据

返回:

当前被统计的数据

getOtherStatData

public Map<StatKey,StatValues> getOtherStatData()

获取另一组非当前正在统计的数据,总共:两组数据进行统计和打印

返回:

非当前正在统计的数据

shouldPrintNow

public boolean shouldPrintNow()

从接口复制的说明: SofaTracerStatisticReporter

当该方法被调用，说明已经过去了一个周期，要判断是否已经过去了足够的周期，是否需要flush

指定者:

shouldPrintNow 在接口中 SofaTracerStatisticReporter

返回:

true 统计数据可以打印,框架会调用 SofaTracerStatisticReporter.print(com.alipay.common.tracer.core.reporter.stat.model.StatKey, long[])

print

public void print(StatKey statKey,
         long[] values)

从接口复制的说明: SofaTracerStatisticReporter

打印,即可以打印到本地磁盘,也可以上报到远程服务器

指定者:

print 在接口中 SofaTracerStatisticReporter

参数:

statKey - 统计关键字

values - 要打印的值

close

public void close()

从接口复制的说明: SofaTracerStatisticReporter

关闭打印能力

指定者:

close 在接口中 SofaTracerStatisticReporter

getIsClosePrint

public AtomicBoolean getIsClosePrint()

setIsClosePrint

public void setIsClosePrint(AtomicBoolean isClosePrint)

buildString

protected String buildString(String[] keys)