com.alibaba.metrics

接口 Compass

所有超级接口:

Counting, Metered, Metric, Sampling

public interface Compass
extends Metered, Sampling

A Compass Metric that wraps: a Timer to measure the qps and rt distribution a Counter to measure the success count a RatioGauge to measure the success rate a Map of Counter> to record the count for each error code a Map of Counter> to record the count for each addon

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	Compass.Context A timing context.

方法概要

限定符和类型	方法和说明
Map<String,BucketCounter>	getAddonCounts() Get the number of occurrence of added on metric 获取扩展指标，包含每个扩展指标的后缀名以及计数
BucketCounter	getBucketSuccessCount() 获取按时间间隔统计的调用成功数
Map<String,BucketCounter>	getErrorCodeCounts() Get the distribution of error code 获取错误码的分布，每个错误码及错误次数
long	getSuccessCount() Get the success count of the invocation 获取调用成功数
double	getSuccessRate() 已过时。
Compass.Context	time() Returns a new Compass.Context.
<T> T	time(Callable<T> event) Times and records the duration of event.
void	update(long duration, TimeUnit unit) Adds a recorded duration.
void	update(long duration, TimeUnit unit, boolean isSuccess, String errorCode, String addon) Adds a recorded duration

从接口继承的方法 com.alibaba.metrics.Metered

getCount, getFifteenMinuteRate, getFiveMinuteRate, getInstantCount, getInstantCount, getInstantCountInterval, getMeanRate, getOneMinuteRate

从接口继承的方法 com.alibaba.metrics.Metric

lastUpdateTime

从接口继承的方法 com.alibaba.metrics.Sampling

getSnapshot

方法详细资料

update

void update(long duration,
            TimeUnit unit)

Adds a recorded duration.

参数:

duration - the length of the duration

unit - the scale unit of duration

update

void update(long duration,
            TimeUnit unit,
            boolean isSuccess,
            String errorCode,
            String addon)

Adds a recorded duration

参数:

duration - the length of the duration

unit - the scale unit of duration

isSuccess - whether it is success

errorCode - the error code with this record, if not, null be passed

addon - the addon with this record, if not, null be passed

time

<T> T time(Callable<T> event)
    throws Exception

Times and records the duration of event.

类型参数:

T - the type of the value returned by event

参数:

event - a Callable whose Callable.call() method implements a process whose duration should be timed

返回:

the value returned by event

抛出:

Exception - if event throws an Exception

time

Compass.Context time()

Returns a new Compass.Context. 获取一个上下文实例, 这个上下文中记录了这次调用的起始时间

返回:

a new Compass.Context

另请参阅:

Compass.Context

getErrorCodeCounts

Map<String,BucketCounter> getErrorCodeCounts()

Get the distribution of error code 获取错误码的分布，每个错误码及错误次数

返回:

the distribution of error code

getSuccessRate

@Deprecated
double getSuccessRate()

已过时。

Get the success rate of the invocation 获取调用成功率, 这个成功率没有意义, 后续将不再提供

返回:

the success rate

getSuccessCount

long getSuccessCount()

Get the success count of the invocation 获取调用成功数

返回:

the success count

getBucketSuccessCount

BucketCounter getBucketSuccessCount()

获取按时间间隔统计的调用成功数

返回:

the bucket success count

getAddonCounts

Map<String,BucketCounter> getAddonCounts()

Get the number of occurrence of added on metric 获取扩展指标，包含每个扩展指标的后缀名以及计数

返回:

the distribution of error code