MetricRegistry (metrics-core-api 2.0.1 API)

java.lang.Object
- com.alibaba.metrics.MetricRegistry

所有已实现的接口:: Metric, MetricSet

public abstract class MetricRegistry
extends Object
implements MetricSet

A registry of metric instances.

构造器概要

构造器
构造器和说明

MetricRegistry()

构造器
构造器和说明
`MetricRegistry()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`abstract void`	`addListener(MetricRegistryListener listener)` Adds a `MetricRegistryListener` to a collection of listeners that will be notified on metric creation.
`abstract ClusterHistogram`	`clusterHistogram(MetricName name, long[] buckets)` Creates a new `ClusterHistogram` and registers it under the given name.
`abstract Compass`	`compass(MetricName name)` Return the `Compass` registered under this name; or create and register a new `Timer` if none is registered.
`abstract Compass`	`compass(MetricName name, ReservoirType type)` Create a compass with given name, and reservoir type
`abstract Compass`	`compass(String name)` Creates a new `Compass` and registers it under the given name.
`abstract Counter`	`counter(MetricName name)` Return the `Counter` registered under this name; or create and register a new `Counter` if none is registered.
`abstract Counter`	`counter(String name)` Creates a new `Counter` and registers it under the given name.
`abstract FastCompass`	`fastCompass(MetricName name)` Create a FastCompass with given name
`abstract SortedMap<MetricName,ClusterHistogram>`	`getClusterHistograms(MetricFilter filter)` Returns a map of all the `ClusterHistogram` in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Compass>`	`getCompasses()` Returns a map of all the compasses in the registry and their names.
`abstract SortedMap<MetricName,Compass>`	`getCompasses(MetricFilter filter)` Returns a map of all the compasses in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Counter>`	`getCounters()` Returns a map of all the counters in the registry and their names.
`abstract SortedMap<MetricName,Counter>`	`getCounters(MetricFilter filter)` Returns a map of all the counters in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,FastCompass>`	`getFastCompasses()` Returns a map of all the compasses in the registry and their names.
`abstract SortedMap<MetricName,FastCompass>`	`getFastCompasses(MetricFilter filter)` Returns a map of all the compasses in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Gauge>`	`getGauges()` Returns a map of all the gauges in the registry and their names.
`abstract SortedMap<MetricName,Gauge>`	`getGauges(MetricFilter filter)` Returns a map of all the gauges in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Histogram>`	`getHistograms()` Returns a map of all the histograms in the registry and their names.
`abstract SortedMap<MetricName,Histogram>`	`getHistograms(MetricFilter filter)` Returns a map of all the histograms in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Meter>`	`getMeters()` Returns a map of all the meters in the registry and their names.
`abstract SortedMap<MetricName,Meter>`	`getMeters(MetricFilter filter)` Returns a map of all the meters in the registry and their names which match the given filter.
`abstract SortedMap<MetricName,Metric>`	`getMetrics(MetricFilter filter)` Returns a map of all the metrics in the registry and their names which match the given filter
`abstract SortedSet<MetricName>`	`getNames()` Returns a set of the names of all the metrics in the registry.
`abstract SortedMap<MetricName,Timer>`	`getTimers()` Returns a map of all the timers in the registry and their names.
`abstract SortedMap<MetricName,Timer>`	`getTimers(MetricFilter filter)` Returns a map of all the timers in the registry and their names which match the given filter.
`abstract Histogram`	`histogram(MetricName name)` Return the `Histogram` registered under this name; or create and register a new `Histogram` if none is registered.
`abstract Histogram`	`histogram(MetricName name, ReservoirType type)` Create a histogram with given name, and reservoir type
`abstract Histogram`	`histogram(String name)` Creates a new `Histogram` and registers it under the given name.
`abstract Meter`	`meter(MetricName name)` Return the `Meter` registered under this name; or create and register a new `Meter` if none is registered.
`abstract Meter`	`meter(String name)` Creates a new `Meter` and registers it under the given name.
`static MetricName`	`name(Class<?> klass, String... names)`
`static MetricName`	`name(String name, String... names)` Shorthand method for backwards compatibility in creating metric names.
`abstract <T extends Metric> T`	`register(MetricName name, T metric)` Given a `Metric`, registers it under the given name.
`abstract <T extends Metric> T`	`register(String name, T metric)` Given a `Metric`, registers it under the given name.
`abstract void`	`registerAll(MetricSet metrics)` Given a metric set, registers them.
`abstract boolean`	`remove(MetricName name)` Removes the metric with the given name.
`abstract void`	`removeListener(MetricRegistryListener listener)` Removes a `MetricRegistryListener` from this registry's collection of listeners.
`abstract void`	`removeMatching(MetricFilter filter)` Removes all metrics which match the given filter.
`abstract Timer`	`timer(MetricName name)` Return the `Timer` registered under this name; or create and register a new `Timer` if none is registered.
`abstract Timer`	`timer(MetricName name, ReservoirType type)` Create a timer with given name, and reservoir type
`abstract Timer`	`timer(String name)` Creates a new `Timer` and registers it under the given name.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

- 构造器详细资料
  - MetricRegistry
```
public MetricRegistry()
```
- 方法详细资料
  - name
```
public static MetricName name(Class<?> klass,
                              String... names)
```
    另请参阅:
    
    name(String, String...)
  - name
```
public static MetricName name(String name,
                              String... names)
```
    Shorthand method for backwards compatibility in creating metric names. Uses MetricName.build(String...) for its heavy lifting.
    
    参数:
    
    name - The first element of the name
    
    names - The remaining elements of the name
    
    返回:
    
    A metric name matching the specified components.
    
    另请参阅:
    
    MetricName.build(String...)
  - register
```
public abstract <T extends Metric> T register(String name,
                                              T metric)
                                       throws IllegalArgumentException
```
    Given a Metric, registers it under the given name.
    
    类型参数:
    
    T - the type of the metric
    
    参数:
    
    name - the name of the metric
    
    metric - the metric
    
    返回:
    
    metric
    
    抛出:
    
    IllegalArgumentException - if the name is already registered
  - register
```
public abstract <T extends Metric> T register(MetricName name,
                                              T metric)
                                       throws IllegalArgumentException
```
    Given a Metric, registers it under the given name.
    
    类型参数:
    
    T - the type of the metric
    
    参数:
    
    name - the name of the metric
    
    metric - the metric
    
    返回:
    
    metric
    
    抛出:
    
    IllegalArgumentException - if the name is already registered
  - registerAll
```
public abstract void registerAll(MetricSet metrics)
                          throws IllegalArgumentException
```
    Given a metric set, registers them.
    
    参数:
    
    metrics - a set of metrics
    
    抛出:
    
    IllegalArgumentException - if any of the names are already registered
  - counter
```
public abstract Counter counter(String name)
```
    Creates a new Counter and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new Counter
  - counter
```
public abstract Counter counter(MetricName name)
```
    Return the Counter registered under this name; or create and register a new Counter if none is registered.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new or pre-existing Counter
  - histogram
```
public abstract Histogram histogram(MetricName name)
```
    Return the Histogram registered under this name; or create and register a new Histogram if none is registered.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new or pre-existing Histogram
  - histogram
```
public abstract Histogram histogram(MetricName name,
                                    ReservoirType type)
```
    Create a histogram with given name, and reservoir type
    
    参数:
    
    name - the name of the metric
    
    type - the type of reservoir
    
    返回:
    
    a histogram instance
  - histogram
```
public abstract Histogram histogram(String name)
```
    Creates a new Histogram and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new Histogram
  - meter
```
public abstract Meter meter(MetricName name)
```
    Return the Meter registered under this name; or create and register a new Meter if none is registered.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new or pre-existing Meter
  - meter
```
public abstract Meter meter(String name)
```
    Creates a new Meter and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new Meter
  - timer
```
public abstract Timer timer(MetricName name)
```
    Return the Timer registered under this name; or create and register a new Timer if none is registered.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new or pre-existing Timer
  - timer
```
public abstract Timer timer(MetricName name,
                            ReservoirType type)
```
    Create a timer with given name, and reservoir type
    
    参数:
    
    name - the name of the metric
    
    type - the type of reservoir
    
    返回:
    
    a timer instance
  - timer
```
public abstract Timer timer(String name)
```
    Creates a new Timer and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new Timer
  - compass
```
public abstract Compass compass(MetricName name)
```
    Return the Compass registered under this name; or create and register a new Timer if none is registered.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new or pre-existing Compass
  - compass
```
public abstract Compass compass(MetricName name,
                                ReservoirType type)
```
    Create a compass with given name, and reservoir type
    
    参数:
    
    name - the name of the metric
    
    type - the type of reservoir
    
    返回:
    
    a compass instance
  - fastCompass
```
public abstract FastCompass fastCompass(MetricName name)
```
    Create a FastCompass with given name
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a FastCompass instance
  - compass
```
public abstract Compass compass(String name)
```
    Creates a new Compass and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    a new Compass
  - clusterHistogram
```
public abstract ClusterHistogram clusterHistogram(MetricName name,
                                                  long[] buckets)
```
    Creates a new ClusterHistogram and registers it under the given name.
    
    参数:
    
    name - the name of the metric
    
    buckets - the array of long values for buckets
    
    返回:
    
    a new ClusterHistogram
  - remove
```
public abstract boolean remove(MetricName name)
```
    Removes the metric with the given name.
    
    参数:
    
    name - the name of the metric
    
    返回:
    
    whether or not the metric was removed
  - removeMatching
```
public abstract void removeMatching(MetricFilter filter)
```
    Removes all metrics which match the given filter.
    
    参数:
    
    filter - a filter
  - addListener
```
public abstract void addListener(MetricRegistryListener listener)
```
    Adds a MetricRegistryListener to a collection of listeners that will be notified on metric creation. Listeners will be notified in the order in which they are added.
    N.B.: The listener will be notified of all existing metrics when it first registers.
    
    参数:
    
    listener - the listener that will be notified
  - removeListener
```
public abstract void removeListener(MetricRegistryListener listener)
```
    Removes a MetricRegistryListener from this registry's collection of listeners.
    
    参数:
    
    listener - the listener that will be removed
  - getNames
```
public abstract SortedSet<MetricName> getNames()
```
    Returns a set of the names of all the metrics in the registry.
    
    返回:
    
    the names of all the metrics
  - getGauges
```
public abstract SortedMap<MetricName,Gauge> getGauges()
```
    Returns a map of all the gauges in the registry and their names.
    
    返回:
    
    all the gauges in the registry
  - getGauges
```
public abstract SortedMap<MetricName,Gauge> getGauges(MetricFilter filter)
```
    Returns a map of all the gauges in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the gauges in the registry
  - getCounters
```
public abstract SortedMap<MetricName,Counter> getCounters()
```
    Returns a map of all the counters in the registry and their names.
    
    返回:
    
    all the counters in the registry
  - getCounters
```
public abstract SortedMap<MetricName,Counter> getCounters(MetricFilter filter)
```
    Returns a map of all the counters in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the counters in the registry
  - getHistograms
```
public abstract SortedMap<MetricName,Histogram> getHistograms()
```
    Returns a map of all the histograms in the registry and their names.
    
    返回:
    
    all the histograms in the registry
  - getHistograms
```
public abstract SortedMap<MetricName,Histogram> getHistograms(MetricFilter filter)
```
    Returns a map of all the histograms in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the histograms in the registry
  - getMeters
```
public abstract SortedMap<MetricName,Meter> getMeters()
```
    Returns a map of all the meters in the registry and their names.
    
    返回:
    
    all the meters in the registry
  - getMeters
```
public abstract SortedMap<MetricName,Meter> getMeters(MetricFilter filter)
```
    Returns a map of all the meters in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the meters in the registry
  - getTimers
```
public abstract SortedMap<MetricName,Timer> getTimers()
```
    Returns a map of all the timers in the registry and their names.
    
    返回:
    
    all the timers in the registry
  - getTimers
```
public abstract SortedMap<MetricName,Timer> getTimers(MetricFilter filter)
```
    Returns a map of all the timers in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the timers in the registry
  - getCompasses
```
public abstract SortedMap<MetricName,Compass> getCompasses()
```
    Returns a map of all the compasses in the registry and their names.
    
    返回:
    
    all the compasses in the registry
  - getCompasses
```
public abstract SortedMap<MetricName,Compass> getCompasses(MetricFilter filter)
```
    Returns a map of all the compasses in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the compasses in the registry
  - getFastCompasses
```
public abstract SortedMap<MetricName,FastCompass> getFastCompasses()
```
    Returns a map of all the compasses in the registry and their names.
    
    返回:
    
    all the compasses in the registry
  - getFastCompasses
```
public abstract SortedMap<MetricName,FastCompass> getFastCompasses(MetricFilter filter)
```
    Returns a map of all the compasses in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the compasses in the registry
  - getClusterHistograms
```
public abstract SortedMap<MetricName,ClusterHistogram> getClusterHistograms(MetricFilter filter)
```
    Returns a map of all the ClusterHistogram in the registry and their names which match the given filter.
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the ClusterHistogram in the registry
  - getMetrics
```
public abstract SortedMap<MetricName,Metric> getMetrics(MetricFilter filter)
```
    Returns a map of all the metrics in the registry and their names which match the given filter
    
    参数:
    
    filter - the metric filter to match
    
    返回:
    
    all the metrics in the registry

类 MetricRegistry

构造器概要

方法概要

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

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

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

构造器详细资料

MetricRegistry

方法详细资料

name

name

register

register

registerAll

counter

counter

histogram

histogram

histogram

meter

meter

timer

timer

timer

compass

compass

fastCompass

compass

clusterHistogram

remove

removeMatching

addListener

removeListener

getNames

getGauges

getGauges

getCounters

getCounters

getHistograms

getHistograms

getMeters

getMeters

getTimers

getTimers

getCompasses

getCompasses

getFastCompasses

getFastCompasses

getClusterHistograms

getMetrics