A B C D E 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.

APPLICATION_SCOPE - Static variable in interface org.eclipse.microprofile.metrics.MetricRegistry

String constant to represent the scope value used for the application scope

B

BASE_SCOPE - Static variable in interface org.eclipse.microprofile.metrics.MetricRegistry

String constant to represent the scope value used for the base scope

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

8 MetricUnits.BITS

C

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. If the names are equal: Compare the number of tags. If the tag lengths are equal: Compare the Tags (sorted by the Tag's key value) a) Compare the Tag names/keys lexicographically b) If keys are equal, compare the Tag values lexicographically

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

24 MetricUnits.HOURS

DefaultMetadata - Class in org.eclipse.microprofile.metrics

The default implementation of Metadata

DefaultMetadata(String, String, 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

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

G

Gauge - Annotation Type in org.eclipse.microprofile.metrics.annotation

An annotation for marking a method or field as a gauge.

Gauge<T extends Number> - 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.

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.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.

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).

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 class org.eclipse.microprofile.metrics.Snapshot

Returns the highest value in the snapshot.

getMean() - Method in class org.eclipse.microprofile.metrics.Snapshot

Returns the arithmetic mean of the values in the snapshot.

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.

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.

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

getNames() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry

Returns a set of the names of all the metrics in the registry.

getPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot.PercentileValue

Returns percentile

getScope() - Method in interface org.eclipse.microprofile.metrics.MetricRegistry

Returns the scope of this metric registry.

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

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.

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() - Method in class org.eclipse.microprofile.metrics.Snapshot.PercentileValue

Returns value at percentile

GIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1024 MetricUnits.MEBIBITS

GIGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1000 MetricUnits.MEGABITS

GIGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1000 MetricUnits.MEGABYTES

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

60 MetricUnits.MINUTES

I

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

1024 MetricUnits.BITS

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

1000 MetricUnits.BITS

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

1000 MetricUnits.BYTES

M

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

1024 MetricUnits.KIBIBITS

MEGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1000 MetricUnits.KILOBITS

MEGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1000 MetricUnits.KILOBYTES

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

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. Tags: (Optional) The tags (represented by Tag objects) 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.

MetricUnits - Class in org.eclipse.microprofile.metrics

Standard units constants for metric's Metadata.

MICROSECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1/1000 MetricUnits.MILLISECONDS

MILLISECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

1/1000 MetricUnits.SECONDS

MINUTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

60 MetricUnits.SECONDS

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

1/1000 MetricUnits.MICROSECONDS

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

PercentileValue(double, double) - Constructor for class org.eclipse.microprofile.metrics.Snapshot.PercentileValue

percentileValues() - Method in class org.eclipse.microprofile.metrics.Snapshot

Returns an array of Snapshot.PercentileValue containing the percentiles and associated values of this Snapshot at the moment invocation.

R

RegistryScope - Annotation Type in org.eclipse.microprofile.metrics.annotation

Specifies the scope 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

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

Snapshot.PercentileValue - Class in org.eclipse.microprofile.metrics

Represents a percentile and its value at the moment it was sampled from the Snapshot.

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.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

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 class org.eclipse.microprofile.metrics.Snapshot.PercentileValue

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.Timer

Adds a recorded duration.

V

VENDOR_SCOPE - Static variable in interface org.eclipse.microprofile.metrics.MetricRegistry

String constant to represent the scope value used for the vendor scope

W

withDescription(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder

Sets the description.

withName(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder

Sets the name.

withUnit(String) - Method in class org.eclipse.microprofile.metrics.MetadataBuilder

Sets the unit.

A B C D E G H I K M N O P R S T U V W