org.apache.dubbo.metrics

Interface IMetricManager

All Known Implementing Classes:

NOPMetricManager

public interface IMetricManager

Method Summary

Modifier and Type	Method and Description
BucketCounter	getBucketCounter(String group, MetricName name) Create a BucketCounter metric in given group, and name.
Compass	getCompass(String group, MetricName name) Create a Compass metric in give group, name, and type if not exist, an instance will be created.
Map<MetricName,Compass>	getCompasses(String group, MetricFilter filter) Get all the compasses by the specific group and filter
Counter	getCounter(String group, MetricName name) Create a Counter metric in given group, and name.
Map<MetricName,Counter>	getCounters(String group, MetricFilter filter) Get all the counters by the specific group and 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.
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.

Method Detail

getCounter

Counter getCounter(String group,
                   MetricName name)

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

Parameters:

group - the group of MetricRegistry

name - the name of the metric

Returns:

an instance of counter

getBucketCounter

BucketCounter getBucketCounter(String group,
                               MetricName name)

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

Parameters:

group - the group of MetricRegistry

name - the name of the metric

Returns:

an instance of BucketCounter

getCompass

Compass getCompass(String group,
                   MetricName name)

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

Parameters:

group - the group of MetricRegistry

name - the name of the metric

Returns:

an instance of Compass

register

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

Register a customized metric to specified group.

Parameters:

group: - the group name of MetricRegistry

metric - the metric to register

listMetricGroups

List<String> listMetricGroups()

Get a list of group in current MetricManager

Returns:

a list of group name

listMetricNamesByGroup

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

list all metric names by group

Returns:

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

Parameters:

group - the group name to query

Returns:

the MetricRegistry that is correspondent to the group

getCounters

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

Get all the counters by the specific group and filter

Parameters:

group - the given group

filter - the given filter

Returns:

the MetricName to Counter map

getCompasses

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

Get all the compasses by the specific group and filter

Parameters:

group - the given group

filter - the given filter

Returns:

the MetricName to Compass map

getMetrics

Map<MetricName,Metric> getMetrics(String group)

A map of metric names to metrics.

Returns:

all the metrics