Skip navigation links

MicroProfile Metrics API v3.0
A B C D E F G H I K M N O P R S T U V W 

A

ALL - Static variable in interface org.eclipse.microprofile.metrics.MetricFilter
Matches all metrics, regardless of type or MetricID.

B

BITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents bits.
build() - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
 
builder() - Static method in interface org.eclipse.microprofile.metrics.Metadata
Returns a new builder
builder(Metadata) - Static method in interface org.eclipse.microprofile.metrics.Metadata
Returns a new builder with the Metadata information
BYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

C

close() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer.Context
Equivalent to calling SimpleTimer.Context.stop().
close() - Method in interface org.eclipse.microprofile.metrics.Timer.Context
Equivalent to calling Timer.Context.stop().
compareTo(MetricID) - Method in class org.eclipse.microprofile.metrics.MetricID
Compares two MetricID objects through the following steps:
Compares the names of the two MetricIDs lexicographically.
ConcurrentGauge - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as concurrent gauged.
ConcurrentGauge - Interface in org.eclipse.microprofile.metrics
A concurrent gauge is a gauge that measures parallel invocations of a method.
concurrentGauge(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the ConcurrentGauge registered under the MetricID with this name; or create and register a new ConcurrentGauge if none is registered.
concurrentGauge(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
concurrentGauge(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the ConcurrentGauge registered under the MetricID; or create and register a new ConcurrentGauge if none is registered.
concurrentGauge(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the ConcurrentGauge registered under the MetricID with the Metadata's name; or create and register a new ConcurrentGauge if none is registered.
concurrentGauge(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
Counted - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as counted.
Counter - Interface in org.eclipse.microprofile.metrics
An incrementing counter metric.
counter(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
counter(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Counter registered under the MetricID; or create and register a new Counter if none is registered.
counter(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
Counting - Interface in org.eclipse.microprofile.metrics
An interface for metric types which have counts.

D

DAYS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
dec() - Method in interface org.eclipse.microprofile.metrics.ConcurrentGauge
Decrement the concurrent gauge's value by 1
DefaultMetadata - Class in org.eclipse.microprofile.metrics
The default implementation of Metadata
DefaultMetadata(String, String, String, MetricType, String) - Constructor for class org.eclipse.microprofile.metrics.DefaultMetadata
 
description() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
description() - Method in interface org.eclipse.microprofile.metrics.Metadata
 
displayName() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
displayName() - Method in interface org.eclipse.microprofile.metrics.Metadata
 
dump(OutputStream) - Method in class org.eclipse.microprofile.metrics.Snapshot
Writes the values of the snapshot to the given stream.

E

equals(Object) - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
equals(Object) - Method in class org.eclipse.microprofile.metrics.MetricID
equals(Object) - Method in class org.eclipse.microprofile.metrics.Tag

F

from(String) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Convert the string representation into an enum
from(Class<?>) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Convert the metric Java class into a MetricType
fromClassName(String) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Convert the metric Java class name into a MetricType

G

Gauge - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method or field as a gauge.
Gauge<T> - Interface in org.eclipse.microprofile.metrics
A gauge metric is an instantaneous reading of a particular value.
gauge(String, T, Function<T, R>, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
gauge(MetricID, T, Function<T, R>) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Gauge of type Number registered under the MetricID; or create and register this gauge if none is registered.
gauge(Metadata, T, Function<T, R>, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
gauge(String, Supplier<T>, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
gauge(MetricID, Supplier<T>) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Gauge registered under the MetricID; or create and register this gauge if none is registered.
gauge(Metadata, Supplier<T>, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
get75thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 75th percentile in the distribution.
get95thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 95th percentile in the distribution.
get98thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 98th percentile in the distribution.
get999thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 99.9th percentile in the distribution.
get99thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 99th percentile in the distribution.
getConcurrentGauge(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the ConcurrentGauge registered for the provided MetricID.
getConcurrentGauges() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the concurrent gauges in the registry and their MetricIDs.
getConcurrentGauges(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the concurrent gauges in the registry and their MetricIDs which match the given filter.
getCount() - Method in interface org.eclipse.microprofile.metrics.ConcurrentGauge
Get the current value of the ConcurrentGauge
getCount() - Method in interface org.eclipse.microprofile.metrics.Counter
Returns the counter's current value.
getCount() - Method in interface org.eclipse.microprofile.metrics.Counting
Returns the current count.
getCount() - Method in interface org.eclipse.microprofile.metrics.Histogram
Returns the number of values recorded.
getCount() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getCount() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the number of events which have been marked.
getCount() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
 
getCount() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getCounter(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Counter registered for the provided MetricID.
getCounters() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the counters in the registry and their MetricIDs.
getCounters(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the counters in the registry and their MetricIDs which match the given filter.
getDescription() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getDescription() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the description of the metric if set, otherwise this method returns the empty String.
getDisplayName() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getDisplayName() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the display name if set, otherwise this method returns the metric name.
getElapsedTime() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Returns the total elapsed timing durations of all completed timing events that are recorded with SimpleTimer.update(Duration).
getElapsedTime() - Method in interface org.eclipse.microprofile.metrics.Timer
Returns the total elapsed timing durations of all completed timing events that are recorded with Timer.update(Duration).
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getGauge(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Gauge registered for the provided MetricID.
getGauges() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the gauges in the registry and their MetricIDs.
getGauges(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the gauges in the registry and their MetricIDs which match the given filter.
getHistogram(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Histogram registered for the provided MetricID.
getHistograms() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the histograms in the registry and their MetricIDs.
getHistograms(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the histograms in the registry and their MetricIDs which match the given filter.
getMax() - Method in interface org.eclipse.microprofile.metrics.ConcurrentGauge
Get the maximum value of the ConcurrentGauge for the previously completed full minute.
getMax() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the highest value in the snapshot.
getMaxTimeDuration() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Get the maximum recorded time duration of the SimpleTimer for the previously completed full minute.
getMean() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the arithmetic mean of the values in the snapshot.
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the mean rate at which events have occurred since the meter was created.
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getMedian() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the median value in the distribution.
getMetadata(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Metadata for the provided name.
getMetadata() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the metadata in the registry and their names.
getMeter(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Meter registered for the provided MetricID.
getMeters() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the meters in the registry and their MetricIDs.
getMeters(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the meters in the registry and their MetricIDs which match the given filter.
getMetric(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Metric registered for a provided MetricID.
getMetric(MetricID, Class<T>) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Metric registered for the provided MetricID as the provided type.
getMetricIDs() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a set of the MetricIDs of all the metrics in the registry.
getMetrics(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the metrics in the registry and their MetricIDs which match the given filter.
getMetrics(Class<T>, MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
getMetrics() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the metrics in the registry and their MetricIDs at query time.
getMin() - Method in interface org.eclipse.microprofile.metrics.ConcurrentGauge
Get the minimum value of the ConcurrentGauge for the previously completed full minute.
getMin() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the lowest value in the snapshot.
getMinTimeDuration() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Get the minimum recorded time duration of the SimpleTimer for the previously completed full minute.
getName() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getName() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the metric name.
getName() - Method in class org.eclipse.microprofile.metrics.MetricID
Returns the Metric name associated with this MetricID
getName() - Method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns the name of the MetricRegistry scope.
getNames() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a set of the names of all the metrics in the registry.
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getSimpleTimer(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the SimpleTimer registered for the provided MetricID.
getSimpleTimers() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the simple timers in the registry and their MetricIDs.
getSimpleTimers(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the simple timers in the registry and their MetricIDs which match the given filter.
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Histogram
 
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Sampling
Returns a snapshot of the values.
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getStdDev() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the standard deviation of the values in the snapshot.
getSum() - Method in interface org.eclipse.microprofile.metrics.Histogram
Returns the sum of values recorded.
getTagName() - Method in class org.eclipse.microprofile.metrics.Tag
 
getTags() - Method in class org.eclipse.microprofile.metrics.MetricID
Returns the underlying map containing the tags.
getTagsAsArray() - Method in class org.eclipse.microprofile.metrics.MetricID
Gets the list of tags as an array of Tag objects.
getTagsAsList() - Method in class org.eclipse.microprofile.metrics.MetricID
Gets the list of tags as a list of Tag objects
getTagsAsString() - Method in class org.eclipse.microprofile.metrics.MetricID
Gets the list of tags as a single String in the format 'key="value",key2="value2",...'
getTagValue() - Method in class org.eclipse.microprofile.metrics.Tag
 
getTimer(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Timer registered for the provided MetricID.
getTimers() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the timers in the registry and their MetricIDs.
getTimers(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the timers in the registry and their MetricIDs which match the given filter.
getType() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getType() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the String representation of the MetricType.
getType() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Returns the type of this metric registry.
getTypeRaw() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getTypeRaw() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the MetricType of the metric if set, otherwise it returns MetricType.INVALID
getUnit() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
getUnit() - Method in interface org.eclipse.microprofile.metrics.Metadata
Returns the unit of this metric if set, otherwise this method returns MetricUnits.NONE
getValue() - Method in interface org.eclipse.microprofile.metrics.Gauge
Returns the metric's current value.
getValue(double) - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the given quantile.
getValues() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the entire set of values in the snapshot.
GIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
GIGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
GIGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

H

hashCode() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
hashCode() - Method in class org.eclipse.microprofile.metrics.MetricID
hashCode() - Method in class org.eclipse.microprofile.metrics.Tag
Histogram - Interface in org.eclipse.microprofile.metrics
A metric which calculates the distribution of a value.
histogram(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
histogram(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Histogram registered under the MetricID; or create and register a new Histogram if none is registered.
histogram(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
HOURS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

I

inc() - Method in interface org.eclipse.microprofile.metrics.ConcurrentGauge
Increment the concurrent gauge's value by 1
inc() - Method in interface org.eclipse.microprofile.metrics.Counter
Increment the counter by one.
inc(long) - Method in interface org.eclipse.microprofile.metrics.Counter
Increment the counter by n.

K

KIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
KILOBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
KILOBYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

M

mark() - Method in interface org.eclipse.microprofile.metrics.Meter
Mark the occurrence of an event.
mark(long) - Method in interface org.eclipse.microprofile.metrics.Meter
Mark the occurrence of a given number of events.
matches(MetricID, Metric) - Method in interface org.eclipse.microprofile.metrics.MetricFilter
Returns true if the metric matches the filter; false otherwise.
MEBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MEGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MEGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Metadata - Interface in org.eclipse.microprofile.metrics
Bean holding the metadata of one single metric.
MetadataBuilder - Class in org.eclipse.microprofile.metrics
The Metadata builder.
MetadataBuilder() - Constructor for class org.eclipse.microprofile.metrics.MetadataBuilder
 
Meter - Interface in org.eclipse.microprofile.metrics
A meter metric which measures mean throughput and one-, five-, and fifteen-minute exponentially-weighted moving average throughputs.
meter(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
meter(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Meter registered under the MetricID; or create and register a new Meter if none is registered.
meter(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
Metered - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as metered.
Metered - Interface in org.eclipse.microprofile.metrics
An object which maintains mean and exponentially-weighted rate.
Metric - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation requesting that a metric be injected or registered.
Metric - Interface in org.eclipse.microprofile.metrics
A tag interface to indicate that a class is a metric.
MetricFilter - Interface in org.eclipse.microprofile.metrics
A filter used to determine whether or not a metric should be reported, among other things.
MetricID - Class in org.eclipse.microprofile.metrics
A unique identifier for Metric and Metadata that are registered in the MetricRegistry The MetricID contains: Name: (Required) The name of the metric.
MetricID(String) - Constructor for class org.eclipse.microprofile.metrics.MetricID
Constructs a MetricID with the given metric name and no tags.
MetricID(String, Tag...) - Constructor for class org.eclipse.microprofile.metrics.MetricID
Constructs a MetricID with the given metric name and Tags.
MetricRegistry - Interface in org.eclipse.microprofile.metrics
The registry that stores metrics and their metadata.
MetricRegistry.Type - Enum in org.eclipse.microprofile.metrics
An enumeration representing the scopes of the MetricRegistry
MetricType - Enum in org.eclipse.microprofile.metrics
An enumeration representing the different types of metrics.
MetricUnits - Class in org.eclipse.microprofile.metrics
Standard units constants for metric's Metadata.
MICROSECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MILLISECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MINUTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

N

name(String, String...) - Static method in interface org.eclipse.microprofile.metrics.MetricRegistry
Concatenates elements to form a dotted name, eliding any null values or empty strings.
name(Class<?>, String...) - Static method in interface org.eclipse.microprofile.metrics.MetricRegistry
Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
NANOSECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
NONE - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
No unit

O

org.eclipse.microprofile.metrics - package org.eclipse.microprofile.metrics
MicroProfile Metrics
org.eclipse.microprofile.metrics.annotation - package org.eclipse.microprofile.metrics.annotation
This package contains the annotations used for MicroProfile Metrics.

P

PER_SECOND - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represent per second
PERCENT - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents percentage

R

register(String, T) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Given a Metric, registers it under a MetricID with the given name and with no tags.
register(Metadata, T) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Given a Metric and Metadata, registers the metric with a MetricID with the name provided by the Metadata and with no tags.
register(Metadata, T, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Given a Metric and Metadata, registers both under a MetricID with the name provided by the Metadata and with the provided Tags.
RegistryType - Annotation Type in org.eclipse.microprofile.metrics.annotation
Qualifies the type of Metric Registry to inject.
remove(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Removes all metrics with the given name.
remove(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Removes the metric with the given MetricID
removeMatching(MetricFilter) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Removes all metrics which match the given filter.

S

Sampling - Interface in org.eclipse.microprofile.metrics
An object which samples values.
SECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents seconds
simpleTimer(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
simpleTimer(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the SimpleTimer registered under the MetricID; or create and register a new SimpleTimer if none is registered.
simpleTimer(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
SimpleTimer - Interface in org.eclipse.microprofile.metrics
A simple timer metric which tracks elapsed time durations and count.
SimpleTimer.Context - Interface in org.eclipse.microprofile.metrics
A timing context.
SimplyTimed - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as simply timed.
size() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the number of values in the snapshot.
Snapshot - Class in org.eclipse.microprofile.metrics
A statistical snapshot of a Snapshot.
Snapshot() - Constructor for class org.eclipse.microprofile.metrics.Snapshot
 
stop() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer.Context
Updates the simple timer with the difference between current and start time.
stop() - Method in interface org.eclipse.microprofile.metrics.Timer.Context
Updates the timer with the difference between current and start time.

T

Tag - Class in org.eclipse.microprofile.metrics
Tag represents a singular metric tag key and value pair.
Tag(String, String) - Constructor for class org.eclipse.microprofile.metrics.Tag
Constructs the Tag object with the given tag name and tag value
time(Callable<T>) - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Times and records the duration of event.
time(Runnable) - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Times and records the duration of event.
time() - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Returns a new SimpleTimer.Context.
time(Callable<T>) - Method in interface org.eclipse.microprofile.metrics.Timer
Times and records the duration of event.
time(Runnable) - Method in interface org.eclipse.microprofile.metrics.Timer
Times and records the duration of event.
time() - Method in interface org.eclipse.microprofile.metrics.Timer
Returns a new Timer.Context.
Timed - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as timed.
timer(String) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(String, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
timer(MetricID) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
Return the Timer registered under the MetricID; or create and register a new Timer if none is registered.
timer(Metadata) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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(Metadata, Tag...) - Method in interface org.eclipse.microprofile.metrics.MetricRegistry
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.
Timer - Interface in org.eclipse.microprofile.metrics
A timer metric which aggregates timing durations and provides duration statistics, plus throughput statistics via Meter.
Timer.Context - Interface in org.eclipse.microprofile.metrics
A timing context.
toString() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
toString() - Method in class org.eclipse.microprofile.metrics.MetricID
 
toString() - Method in enum org.eclipse.microprofile.metrics.MetricType
 
toString() - Method in class org.eclipse.microprofile.metrics.Tag
 

U

unit() - Method in class org.eclipse.microprofile.metrics.DefaultMetadata
 
unit() - Method in interface org.eclipse.microprofile.metrics.Metadata
 
update(int) - Method in interface org.eclipse.microprofile.metrics.Histogram
Adds a recorded value.
update(long) - Method in interface org.eclipse.microprofile.metrics.Histogram
Adds a recorded value.
update(Duration) - Method in interface org.eclipse.microprofile.metrics.SimpleTimer
Adds a recorded duration.
update(Duration) - Method in interface org.eclipse.microprofile.metrics.Timer
Adds a recorded duration.

V

valueOf(String) - Static method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.metrics.MetricType
Returns an array containing the constants of this enum type, in the order they are declared.

W

withDescription(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
Sets the description.
withDisplayName(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
Sets the displayName.
withName(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
Sets the name.
withType(MetricType) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
Sets the type.
withUnit(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder
Sets the unit.
A B C D E F G H I K M N O P R S T U V W 
Skip navigation links

MicroProfile Metrics API v3.0

Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.