MetricRegistry

```
public interface MetricRegistry
```
The registry that stores metrics and their metadata. The MetricRegistry provides methods to register, create and retrieve metrics and their respective metadata.

See Also:

MetricFilter

Examples (en):

mp-metrics-histogram

Examples (es):

mp-metrics-histogram

Examples (pt):

mp-metrics-histogram

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MetricRegistry.Type
An enumeration representing the scopes of the MetricRegistry

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MetricRegistry.Type` An enumeration representing the scopes of the MetricRegistry

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ConcurrentGauge`	`concurrentGauge(Metadata metadata)` Return the `ConcurrentGauge` registered under the `MetricID` with the `Metadata`'s name; or create and register a new `ConcurrentGauge` if none is registered.
`ConcurrentGauge`	`concurrentGauge(Metadata metadata, Tag... tags)` Return the `ConcurrentGauge` registered under the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `ConcurrentGauge` if none is registered.
`ConcurrentGauge`	`concurrentGauge(MetricID metricID)` Return the `ConcurrentGauge` registered under the `MetricID`; or create and register a new `ConcurrentGauge` if none is registered.
`ConcurrentGauge`	`concurrentGauge(java.lang.String name)` Return the `ConcurrentGauge` registered under the `MetricID` with this name; or create and register a new `ConcurrentGauge` if none is registered.
`ConcurrentGauge`	`concurrentGauge(java.lang.String name, Tag... tags)` Return the `ConcurrentGauge` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `ConcurrentGauge` if none is registered.
`Counter`	`counter(Metadata metadata)` Return the `Counter` registered under the `MetricID` with the `Metadata`'s name and with no tags; or create and register a new `Counter` if none is registered.
`Counter`	`counter(Metadata metadata, Tag... tags)` Return the `Counter` registered under the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `Counter` if none is registered.
`Counter`	`counter(MetricID metricID)` Return the `Counter` registered under the `MetricID`; or create and register a new `Counter` if none is registered.
`Counter`	`counter(java.lang.String name)` Return the `Counter` registered under the `MetricID` with this name and with no tags; or create and register a new `Counter` if none is registered.
`Counter`	`counter(java.lang.String name, Tag... tags)` Return the `Counter` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `Counter` if none is registered.
`<T extends java.lang.Number> Gauge<T>`	`gauge(Metadata metadata, java.util.function.Supplier<T> supplier, Tag... tags)` Return the `Gauge` registered under the `MetricID` with the @{link Metadata}'s name and with the provided `Tag`s; or create and register this gauge if none is registered.
`<T,R extends java.lang.Number> Gauge<R>`	`gauge(Metadata metadata, T object, java.util.function.Function<T,R> func, Tag... tags)` Return the `Gauge` of type `Number` registered under the `MetricID` with the @{link Metadata}'s name and with the provided `Tag`s; or create and register this gauge if none is registered.
`<T extends java.lang.Number> Gauge<T>`	`gauge(MetricID metricID, java.util.function.Supplier<T> supplier)` Return the `Gauge` registered under the `MetricID`; or create and register this gauge if none is registered.
`<T,R extends java.lang.Number> Gauge<R>`	`gauge(MetricID metricID, T object, java.util.function.Function<T,R> func)` Return the `Gauge` of type `Number` registered under the `MetricID`; or create and register this gauge if none is registered.
`<T extends java.lang.Number> Gauge<T>`	`gauge(java.lang.String name, java.util.function.Supplier<T> supplier, Tag... tags)` Return the `Gauge` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register this gauge if none is registered.
`<T,R extends java.lang.Number> Gauge<R>`	`gauge(java.lang.String name, T object, java.util.function.Function<T,R> func, Tag... tags)` Return the `Gauge` of type `Number` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register this gauge if none is registered.
`ConcurrentGauge`	`getConcurrentGauge(MetricID metricID)` Return the `ConcurrentGauge` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,ConcurrentGauge>`	`getConcurrentGauges()` Returns a map of all the concurrent gauges in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,ConcurrentGauge>`	`getConcurrentGauges(MetricFilter filter)` Returns a map of all the concurrent gauges in the registry and their `MetricID`s which match the given filter.
`Counter`	`getCounter(MetricID metricID)` Return the `Counter` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,Counter>`	`getCounters()` Returns a map of all the counters in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,Counter>`	`getCounters(MetricFilter filter)` Returns a map of all the counters in the registry and their `MetricID`s which match the given filter.
`Gauge<?>`	`getGauge(MetricID metricID)` Return the `Gauge` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,Gauge>`	`getGauges()` Returns a map of all the gauges in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,Gauge>`	`getGauges(MetricFilter filter)` Returns a map of all the gauges in the registry and their `MetricID`s which match the given filter.
`Histogram`	`getHistogram(MetricID metricID)` Return the `Histogram` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,Histogram>`	`getHistograms()` Returns a map of all the histograms in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,Histogram>`	`getHistograms(MetricFilter filter)` Returns a map of all the histograms in the registry and their `MetricID`s which match the given filter.
`java.util.Map<java.lang.String,Metadata>`	`getMetadata()` Returns a map of all the metadata in the registry and their names.
`Metadata`	`getMetadata(java.lang.String name)` Return the `Metadata` for the provided name.
`Meter`	`getMeter(MetricID metricID)` Return the `Meter` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,Meter>`	`getMeters()` Returns a map of all the meters in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,Meter>`	`getMeters(MetricFilter filter)` Returns a map of all the meters in the registry and their `MetricID`s which match the given filter.
`Metric`	`getMetric(MetricID metricID)` Return the `Metric` registered for a provided `MetricID`.
`<T extends Metric> T`	`getMetric(MetricID metricID, java.lang.Class<T> asType)` Return the `Metric` registered for the provided `MetricID` as the provided type.
`java.util.SortedSet<MetricID>`	`getMetricIDs()` Returns a set of the `MetricID`s of all the metrics in the registry.
`java.util.Map<MetricID,Metric>`	`getMetrics()` Returns a map of all the metrics in the registry and their `MetricID`s at query time.
`<T extends Metric> java.util.SortedMap<MetricID,T>`	`getMetrics(java.lang.Class<T> ofType, MetricFilter filter)` Returns a map of all the metrics in the registry and their `MetricID`s which match the given filter and which are assignable to the provided type.
`java.util.SortedMap<MetricID,Metric>`	`getMetrics(MetricFilter filter)` Returns a map of all the metrics in the registry and their `MetricID`s which match the given filter.
`java.util.SortedSet<java.lang.String>`	`getNames()` Returns a set of the names of all the metrics in the registry.
`SimpleTimer`	`getSimpleTimer(MetricID metricID)` Return the `SimpleTimer` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,SimpleTimer>`	`getSimpleTimers()` Returns a map of all the simple timers in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,SimpleTimer>`	`getSimpleTimers(MetricFilter filter)` Returns a map of all the simple timers in the registry and their `MetricID`s which match the given filter.
`Timer`	`getTimer(MetricID metricID)` Return the `Timer` registered for the provided `MetricID`.
`java.util.SortedMap<MetricID,Timer>`	`getTimers()` Returns a map of all the timers in the registry and their `MetricID`s.
`java.util.SortedMap<MetricID,Timer>`	`getTimers(MetricFilter filter)` Returns a map of all the timers in the registry and their `MetricID`s which match the given filter.
`MetricRegistry.Type`	`getType()` Returns the type of this metric registry.
`Histogram`	`histogram(Metadata metadata)` Return the `Histogram` registered under the `MetricID` with the `Metadata`'s name and with no tags; or create and register a new `Histogram` if none is registered.
`Histogram`	`histogram(Metadata metadata, Tag... tags)` Return the `Histogram` registered under the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `Histogram` if none is registered.
`Histogram`	`histogram(MetricID metricID)` Return the `Histogram` registered under the `MetricID`; or create and register a new `Histogram` if none is registered.
`Histogram`	`histogram(java.lang.String name)` Return the `Histogram` registered under the `MetricID` with this name and with no tags; or create and register a new `Histogram` if none is registered.
`Histogram`	`histogram(java.lang.String name, Tag... tags)` Return the `Histogram` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `Histogram` if none is registered.
`Meter`	`meter(Metadata metadata)` Return the `Meter` registered under the `MetricID` with the `Metadata`'s name and with no tags; or create and register a new `Meter` if none is registered.
`Meter`	`meter(Metadata metadata, Tag... tags)` Return the `Meter` registered under the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `Meter` if none is registered.
`Meter`	`meter(MetricID metricID)` Return the `Meter` registered under the `MetricID`; or create and register a new `Meter` if none is registered.
`Meter`	`meter(java.lang.String name)` Return the `Meter` registered under the `MetricID` with this name and with no tags; or create and register a new `Meter` if none is registered.
`Meter`	`meter(java.lang.String name, Tag... tags)` Return the `Meter` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `Meter` if none is registered.
`static java.lang.String`	`name(java.lang.Class<?> klass, java.lang.String... names)` Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
`static java.lang.String`	`name(java.lang.String name, java.lang.String... names)` Concatenates elements to form a dotted name, eliding any null values or empty strings.
`<T extends Metric> T`	`register(Metadata metadata, T metric)` Given a `Metric` and `Metadata`, registers the metric with a `MetricID` with the name provided by the `Metadata` and with no tags.
`<T extends Metric> T`	`register(Metadata metadata, T metric, Tag... tags)` Given a `Metric` and `Metadata`, registers both under a `MetricID` with the name provided by the `Metadata` and with the provided `Tag`s.
`<T extends Metric> T`	`register(java.lang.String name, T metric)` Given a `Metric`, registers it under a `MetricID` with the given name and with no tags.
`boolean`	`remove(MetricID metricID)` Removes the metric with the given MetricID
`boolean`	`remove(java.lang.String name)` Removes all metrics with the given name.
`void`	`removeMatching(MetricFilter filter)` Removes all metrics which match the given filter.
`SimpleTimer`	`simpleTimer(Metadata metadata)` Return the `SimpleTimer` registered under the the `MetricID` with the `Metadata`'s name and with no tags; or create and register a new `SimpleTimer` if none is registered.
`SimpleTimer`	`simpleTimer(Metadata metadata, Tag... tags)` Return the `SimpleTimer` registered under the the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `SimpleTimer` if none is registered.
`SimpleTimer`	`simpleTimer(MetricID metricID)` Return the `SimpleTimer` registered under the `MetricID`; or create and register a new `SimpleTimer` if none is registered.
`SimpleTimer`	`simpleTimer(java.lang.String name)` Return the `SimpleTimer` registered under the `MetricID` with this name and with no tags; or create and register a new `SimpleTimer` if none is registered.
`SimpleTimer`	`simpleTimer(java.lang.String name, Tag... tags)` Return the `SimpleTimer` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `SimpleTimer` if none is registered.
`Timer`	`timer(Metadata metadata)` Return the `Timer` registered under the the `MetricID` with the `Metadata`'s name and with no tags; or create and register a new `Timer` if none is registered.
`Timer`	`timer(Metadata metadata, Tag... tags)` Return the `Timer` registered under the the `MetricID` with the `Metadata`'s name and with the provided `Tag`s; or create and register a new `Timer` if none is registered.
`Timer`	`timer(MetricID metricID)` Return the `Timer` registered under the `MetricID`; or create and register a new `Timer` if none is registered.
`Timer`	`timer(java.lang.String name)` Return the `Timer` registered under the `MetricID` with this name and with no tags; or create and register a new `Timer` if none is registered.
`Timer`	`timer(java.lang.String name, Tag... tags)` Return the `Timer` registered under the `MetricID` with this name and with the provided `Tag`s; or create and register a new `Timer` if none is registered.

- Method Detail
  - name
```
static java.lang.String name(java.lang.String name,
                             java.lang.String... names)
```
    Concatenates elements to form a dotted name, eliding any null values or empty strings.
    
    Parameters:
    
    name - the first element of the name
    
    names - the remaining elements of the name
    
    Returns:
    
    name and names concatenated by periods
  - name
```
static java.lang.String name(java.lang.Class<?> klass,
                             java.lang.String... names)
```
    Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
    
    Parameters:
    
    klass - the first element of the name
    
    names - the remaining elements of the name
    
    Returns:
    
    klass and names concatenated by periods
  - register
```
<T extends Metric> T register(java.lang.String name,
                              T metric)
                       throws java.lang.IllegalArgumentException
```
    Given a Metric, registers it under a MetricID with the given name and with no tags. A Metadata object will be registered with the name and type. However, if a Metadata object is already registered with this metric name and is not equal to the created Metadata object then an exception will be thrown.
    
    Type Parameters:
    
    T - the type of the metric
    
    Parameters:
    
    name - the name of the metric
    
    metric - the metric
    
    Returns:
    
    metric
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is already registered or if Metadata with different values has already been registered with the name
  - register
```
<T extends Metric> T register(Metadata metadata,
                              T metric)
                       throws java.lang.IllegalArgumentException
```
    Given a Metric and Metadata, registers the metric with a MetricID with the name provided by the Metadata and with no tags.
    Note: If a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Type Parameters:
    
    T - the type of the metric
    
    Parameters:
    
    metadata - the metadata
    
    metric - the metric
    
    Returns:
    
    metric
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is already registered or if Metadata with different values has already been registered with the name
    
    Since:
    
    1.1
  - register
```
<T extends Metric> T register(Metadata metadata,
                              T metric,
                              Tag... tags)
                       throws java.lang.IllegalArgumentException
```
    Given a Metric and Metadata, registers both under a MetricID with the name provided by the Metadata and with the provided Tags.
    Note: If a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Type Parameters:
    
    T - the type of the metric
    
    Parameters:
    
    metadata - the metadata
    
    metric - the metric
    
    tags - the tags of the metric
    
    Returns:
    
    metric
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is already registered or if Metadata with different values has already been registered with the name
    
    Since:
    
    2.0
  - counter
```
Counter counter(java.lang.String name)
```
    Return the Counter registered under the MetricID with this name and with no tags; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing Counter
  - counter
```
Counter counter(java.lang.String name,
                Tag... tags)
```
    Return the Counter registered under the MetricID with this name and with the provided Tags; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Counter
    
    Since:
    
    2.0
  - counter
```
Counter counter(MetricID metricID)
```
    Return the Counter registered under the MetricID; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing Counter
    
    Since:
    
    3.0
  - counter
```
Counter counter(Metadata metadata)
```
    Return the Counter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Counter if none is registered. If a Counter was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing Counter
  - counter
```
Counter counter(Metadata metadata,
                Tag... tags)
```
    Return the Counter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Counter if none is registered. If a Counter was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Counter
    
    Since:
    
    2.0
  - concurrentGauge
```
ConcurrentGauge concurrentGauge(java.lang.String name)
```
    Return the ConcurrentGauge registered under the MetricID with this name; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing ConcurrentGauge
  - concurrentGauge
```
ConcurrentGauge concurrentGauge(java.lang.String name,
                                Tag... tags)
```
    Return the ConcurrentGauge registered under the MetricID with this name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing ConcurrentGauge
  - concurrentGauge
```
ConcurrentGauge concurrentGauge(MetricID metricID)
```
    Return the ConcurrentGauge registered under the MetricID; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing ConcurrentGauge
    
    Since:
    
    3.0
  - concurrentGauge
```
ConcurrentGauge concurrentGauge(Metadata metadata)
```
    Return the ConcurrentGauge registered under the MetricID with the Metadata's name; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing ConcurrentGauge
  - concurrentGauge
```
ConcurrentGauge concurrentGauge(Metadata metadata,
                                Tag... tags)
```
    Return the ConcurrentGauge registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing ConcurrentGauge
  - gauge
```
<T,R extends java.lang.Number> Gauge<R> gauge(java.lang.String name,
                                              T object,
                                              java.util.function.Function<T,R> func,
                                              Tag... tags)
```
    Return the Gauge of type Number registered under the MetricID with this name and with the provided Tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will apply a Function to the provided object to resolve a Number value.
    
    Type Parameters:
    
    T - The Type of the Object of which the function func is applied to
    
    R - A Number
    
    Parameters:
    
    name - The name of the Gauge metric
    
    object - The object that the Function func will be applied to
    
    func - The Function that will be applied to object
    
    tags - The tags of the metric
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - gauge
```
<T,R extends java.lang.Number> Gauge<R> gauge(MetricID metricID,
                                              T object,
                                              java.util.function.Function<T,R> func)
```
    Return the Gauge of type Number registered under the MetricID; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will apply a Function to the provided object to resolve a Number value.
    
    Type Parameters:
    
    T - The Type of the Object of which the function func is applied to
    
    R - A Number
    
    Parameters:
    
    metricID - The MetricID of the Gauge metric
    
    object - The object that the Function func will be applied to
    
    func - The Function that will be applied to object
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - gauge
```
<T,R extends java.lang.Number> Gauge<R> gauge(Metadata metadata,
                                              T object,
                                              java.util.function.Function<T,R> func,
                                              Tag... tags)
```
    Return the Gauge of type Number registered under the MetricID with the @{link Metadata}'s name and with the provided Tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will apply a Function to the provided object to resolve a Number value.
    
    Type Parameters:
    
    T - The Type of the Object of which the function func is applied to
    
    R - A Number
    
    Parameters:
    
    metadata - The Metadata of the Gauge
    
    object - The object that the Function func will be applied to
    
    func - The Function that will be applied to object
    
    tags - The tags of the metric
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - gauge
```
<T extends java.lang.Number> Gauge<T> gauge(java.lang.String name,
                                            java.util.function.Supplier<T> supplier,
                                            Tag... tags)
```
    Return the Gauge registered under the MetricID with this name and with the provided Tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will return the value that the Supplier will provide.
    
    Type Parameters:
    
    T - A Number
    
    Parameters:
    
    name - The name of the Gauge
    
    supplier - The Supplier function that will return the value for the Gauge metric
    
    tags - The tags of the metric
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - gauge
```
<T extends java.lang.Number> Gauge<T> gauge(MetricID metricID,
                                            java.util.function.Supplier<T> supplier)
```
    Return the Gauge registered under the MetricID; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will return the value that the Supplier will provide.
    
    Type Parameters:
    
    T - A Number
    
    Parameters:
    
    metricID - The MetricID
    
    supplier - The Supplier function that will return the value for the Gauge metric
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - gauge
```
<T extends java.lang.Number> Gauge<T> gauge(Metadata metadata,
                                            java.util.function.Supplier<T> supplier,
                                            Tag... tags)
```
    Return the Gauge registered under the MetricID with the @{link Metadata}'s name and with the provided Tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used. The created Gauge will return the value that the Supplier will provide.
    
    Type Parameters:
    
    T - A Number
    
    Parameters:
    
    metadata - The metadata of the gauge
    
    supplier - The Supplier function that will return the value for the Gauge metric
    
    tags - The tags of the metric
    
    Returns:
    
    a new or pre-existing Gauge
    
    Since:
    
    3.0
  - histogram
```
Histogram histogram(java.lang.String name)
```
    Return the Histogram registered under the MetricID with this name and with no tags; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing Histogram
  - histogram
```
Histogram histogram(java.lang.String name,
                    Tag... tags)
```
    Return the Histogram registered under the MetricID with this name and with the provided Tags; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Histogram
    
    Since:
    
    2.0
  - histogram
```
Histogram histogram(MetricID metricID)
```
    Return the Histogram registered under the MetricID; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing Histogram
    
    Since:
    
    3.0
  - histogram
```
Histogram histogram(Metadata metadata)
```
    Return the Histogram registered under the MetricID with the Metadata's name and with no tags; or create and register a new Histogram if none is registered. If a Histogram was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing Histogram
  - histogram
```
Histogram histogram(Metadata metadata,
                    Tag... tags)
```
    Return the Histogram registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Histogram if none is registered. If a Histogram was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Histogram
    
    Since:
    
    2.0
  - meter
```
Meter meter(java.lang.String name)
```
    Return the Meter registered under the MetricID with this name and with no tags; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing Meter
  - meter
```
Meter meter(java.lang.String name,
            Tag... tags)
```
    Return the Meter registered under the MetricID with this name and with the provided Tags; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Meter
    
    Since:
    
    2.0
  - meter
```
Meter meter(MetricID metricID)
```
    Return the Meter registered under the MetricID; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing Meter
    
    Since:
    
    3.0
  - meter
```
Meter meter(Metadata metadata)
```
    Return the Meter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Meter if none is registered. If a Meter was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing Meter
  - meter
```
Meter meter(Metadata metadata,
            Tag... tags)
```
    Return the Meter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Meter if none is registered. If a Meter was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Meter
    
    Since:
    
    2.0
  - timer
```
Timer timer(java.lang.String name)
```
    Return the Timer registered under the MetricID with this name and with no tags; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing Timer
  - timer
```
Timer timer(java.lang.String name,
            Tag... tags)
```
    Return the Timer registered under the MetricID with this name and with the provided Tags; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Timer
    
    Since:
    
    2.0
  - timer
```
Timer timer(MetricID metricID)
```
    Return the Timer registered under the MetricID; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing Timer
    
    Since:
    
    3.0
  - timer
```
Timer timer(Metadata metadata)
```
    Return the Timer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new Timer if none is registered. If a Timer was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing Timer
  - timer
```
Timer timer(Metadata metadata,
            Tag... tags)
```
    Return the Timer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new Timer if none is registered. If a Timer was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing Timer
    
    Since:
    
    2.0
  - simpleTimer
```
SimpleTimer simpleTimer(java.lang.String name)
```
    Return the SimpleTimer registered under the MetricID with this name and with no tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    a new or pre-existing SimpleTimer
    
    Since:
    
    2.3
  - simpleTimer
```
SimpleTimer simpleTimer(java.lang.String name,
                        Tag... tags)
```
    Return the SimpleTimer registered under the MetricID with this name and with the provided Tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    name - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing SimpleTimer
    
    Since:
    
    2.3
  - simpleTimer
```
SimpleTimer simpleTimer(MetricID metricID)
```
    Return the SimpleTimer registered under the MetricID; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.
    
    Parameters:
    
    metricID - the ID of the metric
    
    Returns:
    
    a new or pre-existing SimpleTimer
    
    Since:
    
    3.0
  - simpleTimer
```
SimpleTimer simpleTimer(Metadata metadata)
```
    Return the SimpleTimer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    Returns:
    
    a new or pre-existing SimpleTimer
    
    Since:
    
    2.3
  - simpleTimer
```
SimpleTimer simpleTimer(Metadata metadata,
                        Tag... tags)
```
    Return the SimpleTimer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, the provided Metadata object will be registered.
    Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.
    
    Parameters:
    
    metadata - the name of the metric
    
    tags - the tags of the metric
    
    Returns:
    
    a new or pre-existing SimpleTimer
    
    Since:
    
    2.3
  - getMetric
```
Metric getMetric(MetricID metricID)
```
    Return the Metric registered for a provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Metric registered for the provided MetricID or null if none has been registered so far
    
    Since:
    
    3.0
  - getMetric
```
<T extends Metric> T getMetric(MetricID metricID,
                               java.lang.Class<T> asType)
```
    Return the Metric registered for the provided MetricID as the provided type.
    
    Parameters:
    
    metricID - lookup key, not null
    
    asType - the return type which is expected to be compatible with the actual type of the registered metric
    
    Returns:
    
    the Metric registered for the provided MetricID or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to the provided type
    
    Since:
    
    3.0
  - getCounter
```
Counter getCounter(MetricID metricID)
```
    Return the Counter registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Counter registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to Counter
    
    Since:
    
    3.0
  - getConcurrentGauge
```
ConcurrentGauge getConcurrentGauge(MetricID metricID)
```
    Return the ConcurrentGauge registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the ConcurrentGauge registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to ConcurrentGauge
    
    Since:
    
    3.0
  - getGauge
```
Gauge<?> getGauge(MetricID metricID)
```
    Return the Gauge registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Gauge registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to Gauge
    
    Since:
    
    3.0
  - getHistogram
```
Histogram getHistogram(MetricID metricID)
```
    Return the Histogram registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Histogram registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to Histogram
    
    Since:
    
    3.0
  - getMeter
```
Meter getMeter(MetricID metricID)
```
    Return the Meter registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Meter registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to Meter
    
    Since:
    
    3.0
  - getTimer
```
Timer getTimer(MetricID metricID)
```
    Return the Timer registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the Timer registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to Timer
    
    Since:
    
    3.0
  - getSimpleTimer
```
SimpleTimer getSimpleTimer(MetricID metricID)
```
    Return the SimpleTimer registered for the provided MetricID.
    
    Parameters:
    
    metricID - lookup key, not null
    
    Returns:
    
    the SimpleTimer registered for the key or null if none has been registered so far
    
    Throws:
    
    java.lang.IllegalArgumentException - If the registered metric was not assignable to SimpleTimer
    
    Since:
    
    3.0
  - getMetadata
```
Metadata getMetadata(java.lang.String name)
```
    Return the Metadata for the provided name.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    the Metadata for the provided name of null if none has been registered for that name
    
    Since:
    
    3.0
  - remove
```
boolean remove(java.lang.String name)
```
    Removes all metrics with the given name.
    
    Parameters:
    
    name - the name of the metric
    
    Returns:
    
    whether or not the metric was removed
  - remove
```
boolean remove(MetricID metricID)
```
    Removes the metric with the given MetricID
    
    Parameters:
    
    metricID - the MetricID of the metric
    
    Returns:
    
    whether or not the metric was removed
    
    Since:
    
    2.0
  - removeMatching
```
void removeMatching(MetricFilter filter)
```
    Removes all metrics which match the given filter.
    
    Parameters:
    
    filter - a filter
  - getNames
```
java.util.SortedSet<java.lang.String> getNames()
```
    Returns a set of the names of all the metrics in the registry.
    
    Returns:
    
    the names of all the metrics
  - getMetricIDs
```
java.util.SortedSet<MetricID> getMetricIDs()
```
    Returns a set of the MetricIDs of all the metrics in the registry.
    
    Returns:
    
    the MetricIDs of all the metrics
  - getGauges
```
java.util.SortedMap<MetricID,Gauge> getGauges()
```
    Returns a map of all the gauges in the registry and their MetricIDs.
    
    Returns:
    
    all the gauges in the registry
  - getGauges
```
java.util.SortedMap<MetricID,Gauge> getGauges(MetricFilter filter)
```
    Returns a map of all the gauges in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the gauges in the registry
  - getCounters
```
java.util.SortedMap<MetricID,Counter> getCounters()
```
    Returns a map of all the counters in the registry and their MetricIDs.
    
    Returns:
    
    all the counters in the registry
  - getCounters
```
java.util.SortedMap<MetricID,Counter> getCounters(MetricFilter filter)
```
    Returns a map of all the counters in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the counters in the registry
  - getConcurrentGauges
```
java.util.SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges()
```
    Returns a map of all the concurrent gauges in the registry and their MetricIDs.
    
    Returns:
    
    all the concurrent gauges in the registry
  - getConcurrentGauges
```
java.util.SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges(MetricFilter filter)
```
    Returns a map of all the concurrent gauges in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the concurrent gauges in the registry
  - getHistograms
```
java.util.SortedMap<MetricID,Histogram> getHistograms()
```
    Returns a map of all the histograms in the registry and their MetricIDs.
    
    Returns:
    
    all the histograms in the registry
  - getHistograms
```
java.util.SortedMap<MetricID,Histogram> getHistograms(MetricFilter filter)
```
    Returns a map of all the histograms in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the histograms in the registry
  - getMeters
```
java.util.SortedMap<MetricID,Meter> getMeters()
```
    Returns a map of all the meters in the registry and their MetricIDs.
    
    Returns:
    
    all the meters in the registry
  - getMeters
```
java.util.SortedMap<MetricID,Meter> getMeters(MetricFilter filter)
```
    Returns a map of all the meters in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the meters in the registry
  - getTimers
```
java.util.SortedMap<MetricID,Timer> getTimers()
```
    Returns a map of all the timers in the registry and their MetricIDs.
    
    Returns:
    
    all the timers in the registry
  - getTimers
```
java.util.SortedMap<MetricID,Timer> getTimers(MetricFilter filter)
```
    Returns a map of all the timers in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the timers in the registry
  - getSimpleTimers
```
java.util.SortedMap<MetricID,SimpleTimer> getSimpleTimers()
```
    Returns a map of all the simple timers in the registry and their MetricIDs.
    
    Returns:
    
    all the timers in the registry
  - getSimpleTimers
```
java.util.SortedMap<MetricID,SimpleTimer> getSimpleTimers(MetricFilter filter)
```
    Returns a map of all the simple timers in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the timers in the registry
  - getMetrics
```
java.util.SortedMap<MetricID,Metric> getMetrics(MetricFilter filter)
```
    Returns a map of all the metrics in the registry and their MetricIDs which match the given filter.
    
    Parameters:
    
    filter - the metric filter to match
    
    Returns:
    
    all the metrics in the registry
    
    Since:
    
    3.0
  - getMetrics
```
<T extends Metric> java.util.SortedMap<MetricID,T> getMetrics(java.lang.Class<T> ofType,
                                                              MetricFilter filter)
```
    Returns a map of all the metrics in the registry and their MetricIDs which match the given filter and which are assignable to the provided type.
    
    Parameters:
    
    ofType - the type to which all returned metrics should be assignable
    
    filter - the metric filter to match
    
    Returns:
    
    all the metrics in the registry
    
    Since:
    
    3.0
  - getMetrics
```
java.util.Map<MetricID,Metric> getMetrics()
```
    Returns a map of all the metrics in the registry and their MetricIDs at query time. The only guarantee about this method is that any key has a value (compared to using getMetric(MetricID) and getMetricIDs() together). It is only intended for bulk querying, if you need a single or a few entries, always prefer getMetric(MetricID) or getMetrics(MetricFilter).
    
    Returns:
    
    all the metrics in the registry
  - getMetadata
```
java.util.Map<java.lang.String,Metadata> getMetadata()
```
    Returns a map of all the metadata in the registry and their names. The only guarantee about this method is that any key has a value (compared to using getMetadata(String). It is only intended for bulk querying, if you need a single or a few metadata, always prefer getMetadata(String)}.
    
    Returns:
    
    all the metadata in the registry
  - getType
```
MetricRegistry.Type getType()
```
    Returns the type of this metric registry.
    
    Returns:
    
    Type of this registry (VENDOR, BASE, APPLICATION)

Interface MetricRegistry

Nested Class Summary

Method Summary

Method Detail

name

name

register

register

register

counter

counter

counter

counter

counter

concurrentGauge

concurrentGauge

concurrentGauge

concurrentGauge

concurrentGauge

gauge

gauge

gauge

gauge

gauge

gauge

histogram

histogram

histogram

histogram

histogram

meter

meter

meter

meter

meter

timer

timer

timer

timer

timer

simpleTimer

simpleTimer

simpleTimer

simpleTimer

simpleTimer

getMetric

getMetric

getCounter

getConcurrentGauge

getGauge

getHistogram

getMeter

getTimer

getSimpleTimer

getMetadata

remove

remove

removeMatching

getNames

getMetricIDs

getGauges

getGauges

getCounters

getCounters

getConcurrentGauges

getConcurrentGauges

getHistograms

getHistograms

getMeters

getMeters

getTimers

getTimers

getSimpleTimers

getSimpleTimers

getMetrics

getMetrics

getMetrics

getMetadata

getType