com.alipay.lookout.api

接口 Registry

所有超级接口:

Iterable<Metric>

所有已知实现类:

CompositeRegistry, MetricRegistry, NoopRegistry

public interface Registry
extends Iterable<Metric>

manage a set of metrics. Created by kevin.luy@alipay.com on 2017/2/14.

方法概要

方法

限定符和类型	方法和说明
Clock	clock() The clock used by the registry for timing events.
Counter	counter(Id id) Measures the rate of some activity.
Id	createId(String name) Generate an identifier for a metric.
Id	createId(String name, Iterable<Tag> tags) Generate an identifier for a metric.
Id	createId(String name, Map<String,String> tags)
DistributionSummary	distributionSummary(Id id) Measures the rate and variation in amount for some activity.
<T extends Number> Gauge<T>	gauge(Id id, Gauge<T> gauge) Register a gauge instance
<X extends Metric> X	get(Id id) Returns the metric associated with a given id.
<I,Y extends Info<I>> Info	info(Id id, Y info) Register a info instance
Iterator<Metric>	iterator() Iterator for traversing the set of metrics in the registry.
MixinMetric	mixinMetric(Id id) Generate a mixinMetric
void	propagate(String msg, Throwable t) propagate a exception
void	register(Metric metric) Add a custom metric to the registry.
void	removeMetric(Id id) Remove a metric by id.
Timer	timer(Id id) Measures the rate and time taken for short running tasks.

方法详细资料

clock

Clock clock()

The clock used by the registry for timing events.

返回:

clock

createId

Id createId(String name)

Generate an identifier for a metric.

参数:

name - the name of an metric identifier.

返回:

id

createId

Id createId(String name,
          Iterable<Tag> tags)

Generate an identifier for a metric.

参数:

name - the name of an metric identifier.

tags - the tags of an metric identifier.

返回:

id

createId

Id createId(String name,
          Map<String,String> tags)

register

void register(Metric metric)

Add a custom metric to the registry.

caution: if the same id is already existed,then throw duplicate exception

参数:

metric - metric

gauge

<T extends Number> Gauge<T> gauge(Id id,
                                Gauge<T> gauge)

Register a gauge instance

类型参数:

T - return old one;if this id first register gauge ,return null

参数:

id - metric id

gauge - gauge

返回:

gauge

removeMetric

void removeMetric(Id id)

Remove a metric by id.

参数:

id - metric id

info

<I,Y extends Info<I>> Info info(Id id,
                              Y info)

Register a info instance

参数:

id - metric id

info - an info instance

返回:

counter

Counter counter(Id id)

Measures the rate of some activity. A counter is for continuously incrementing sources like the number of requests that are coming into a server.

参数:

id - metric id

返回:

counter

distributionSummary

DistributionSummary distributionSummary(Id id)

Measures the rate and variation in amount for some activity. For example, it could be used to get insight into the variation in response sizes for requests to a server.

参数:

id - metric id

返回:

DistributionSummary

timer

Timer timer(Id id)

Measures the rate and time taken for short running tasks.

参数:

id - metric id

返回:

timer

mixinMetric

MixinMetric mixinMetric(Id id)

Generate a mixinMetric

参数:

id - metric id

返回:

a mixinMetric instance

get

<X extends Metric> X get(Id id)

Returns the metric associated with a given id.

if reaching the max number,null will be returned too.

参数:

id - metric id

返回:

Instance of the metric or null if there is no match.

iterator

Iterator<Metric> iterator()

Iterator for traversing the set of metrics in the registry.

指定者:

iterator 在接口中 Iterable<Metric>

propagate

void propagate(String msg,
             Throwable t)

propagate a exception

参数:

msg - the exception message

t - the exception