com.alibaba.metrics

接口 IMetricManager

所有已知实现类:

NOPMetricManager

public interface IMetricManager

方法概要

限定符和类型	方法和说明
void	clear() 清空IMetricManager
Map<Class<? extends Metric>,Map<MetricName,? extends Metric>>	getAllCategoryMetrics(MetricFilter filter) return all metrics
Map<Class<? extends Metric>,Map<MetricName,? extends Metric>>	getCategoryMetrics(String group) 返回不同Metric分类，各自保存好的map
Map<Class<? extends Metric>,Map<MetricName,? extends Metric>>	getCategoryMetrics(String group, MetricFilter filter) 返回不同Metric分类，各自保存好的map
ClusterHistogram	getClusterHistogram(String group, MetricName name, long[] buckets) Create a ClusterHistogram metric in give group, name, and type if not exist, an instance will be created.
Compass	getCompass(String group, MetricName name) Create a Compass metric in given group, and name.
Compass	getCompass(String group, MetricName name, ReservoirType type) Create a Compass metric in given group, name, and type if not exist, an instance will be created.
SortedMap<MetricName,Compass>	getCompasses(String group, MetricFilter filter)
Counter	getCounter(String group, MetricName name) Create a Counter metric in given group, and name.
SortedMap<MetricName,Counter>	getCounters(String group, MetricFilter filter)
FastCompass	getFastCompass(String group, MetricName name) Create a FastCompass metric in give group, name, and type if not exist, an instance will be created.
SortedMap<MetricName,FastCompass>	getFastCompasses(String group, MetricFilter filter)
SortedMap<MetricName,Gauge>	getGauges(String group, MetricFilter filter)
Histogram	getHistogram(String group, MetricName name) Create a Histogram metric in given group, and name.
Histogram	getHistogram(String group, MetricName name, ReservoirType type) Create a Histogram metric in given group, name, and type if not exist, an instance will be created.
SortedMap<MetricName,Histogram>	getHistograms(String group, MetricFilter filter)
Meter	getMeter(String group, MetricName name) Create a Meter metric in given group, and name.
SortedMap<MetricName,Meter>	getMeters(String group, MetricFilter filter)
MetricRegistry	getMetricRegistryByGroup(String group) Get metric registry by group name, if not found, null will be returned
Map<MetricName,Metric>	getMetrics(String group) A map of metric names to metrics.
Timer	getTimer(String group, MetricName name) Create a Timer metric in given group, and name.
Timer	getTimer(String group, MetricName name, ReservoirType type) Create a Timer metric in given group, name, and type if not exist, an instance will be created.
SortedMap<MetricName,Timer>	getTimers(String group, MetricFilter filter)
boolean	isEnabled() A global flag to complete disable the metrics feature
List<String>	listMetricGroups() Get a list of group in current MetricManager
Map<String,Set<MetricName>>	listMetricNamesByGroup() list all metric names by group
void	register(String group, MetricName name, Metric metric) Register a customized metric to specified group.
void	setEnabled(boolean enabled) A global flag to complete disable the metrics feature

方法详细资料

getMeter

Meter getMeter(String group,
               MetricName name)

Create a Meter metric in given group, and name. if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of meter

getCounter

Counter getCounter(String group,
                   MetricName name)

Create a Counter metric in given group, and name. if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of counter

getHistogram

Histogram getHistogram(String group,
                       MetricName name)

Create a Histogram metric in given group, and name. if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of histogram

getHistogram

Histogram getHistogram(String group,
                       MetricName name,
                       ReservoirType type)

Create a Histogram metric in given group, name, and type if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

type - the type of the reservoir

返回:

an instance of histogram

getTimer

Timer getTimer(String group,
               MetricName name)

Create a Timer metric in given group, and name. if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of timer

getTimer

Timer getTimer(String group,
               MetricName name,
               ReservoirType type)

Create a Timer metric in given group, name, and type if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

type - the type of the reservoir

返回:

an instance of timer

getCompass

Compass getCompass(String group,
                   MetricName name)

Create a Compass metric in given group, and name. if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of compass

getCompass

Compass getCompass(String group,
                   MetricName name,
                   ReservoirType type)

Create a Compass metric in given group, name, and type if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

type - the type of the reservoir

返回:

an instance of compass

getFastCompass

FastCompass getFastCompass(String group,
                           MetricName name)

Create a FastCompass metric in give group, name, and type if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

返回:

an instance of FastCompass

getClusterHistogram

ClusterHistogram getClusterHistogram(String group,
                                     MetricName name,
                                     long[] buckets)

Create a ClusterHistogram metric in give group, name, and type if not exist, an instance will be created.

参数:

group - the group of MetricRegistry

name - the name of the metric

buckets - if the buckets is null, a default bucket will be created.

返回:

an instance of ClusterHistogram

register

void register(String group,
              MetricName name,
              Metric metric)

Register a customized metric to specified group.

参数:

group: - the group name of MetricRegistry

metric - the metric to register

listMetricGroups

List<String> listMetricGroups()

Get a list of group in current MetricManager

返回:

a list of group name

isEnabled

boolean isEnabled()

A global flag to complete disable the metrics feature

返回:

true if it is enabled.

setEnabled

void setEnabled(boolean enabled)

A global flag to complete disable the metrics feature

listMetricNamesByGroup

Map<String,Set<MetricName>> listMetricNamesByGroup()

list all metric names by group

返回:

a map of metric name set, keyed by group name

getMetricRegistryByGroup

MetricRegistry getMetricRegistryByGroup(String group)

Get metric registry by group name, if not found, null will be returned

参数:

group - the group name to query

返回:

the MetricRegistry that is correspondent to the group

getGauges

SortedMap<MetricName,Gauge> getGauges(String group,
                                      MetricFilter filter)

getCounters

SortedMap<MetricName,Counter> getCounters(String group,
                                          MetricFilter filter)

getHistograms

SortedMap<MetricName,Histogram> getHistograms(String group,
                                              MetricFilter filter)

getMeters

SortedMap<MetricName,Meter> getMeters(String group,
                                      MetricFilter filter)

getTimers

SortedMap<MetricName,Timer> getTimers(String group,
                                      MetricFilter filter)

getCompasses

SortedMap<MetricName,Compass> getCompasses(String group,
                                           MetricFilter filter)

getFastCompasses

SortedMap<MetricName,FastCompass> getFastCompasses(String group,
                                                   MetricFilter filter)

getMetrics

Map<MetricName,Metric> getMetrics(String group)

A map of metric names to metrics.

返回:

the metrics

getCategoryMetrics

Map<Class<? extends Metric>,Map<MetricName,? extends Metric>> getCategoryMetrics(String group)

返回不同Metric分类，各自保存好的map

参数:

group -

返回:

getCategoryMetrics

Map<Class<? extends Metric>,Map<MetricName,? extends Metric>> getCategoryMetrics(String group,
                                                                                 MetricFilter filter)

返回不同Metric分类，各自保存好的map

参数:

group -

filter -

返回:

getAllCategoryMetrics

Map<Class<? extends Metric>,Map<MetricName,? extends Metric>> getAllCategoryMetrics(MetricFilter filter)

return all metrics

参数:

filter -

返回:

clear

void clear()

清空IMetricManager