Class GaugeMetric
java.lang.Object
org.eclipse.microprofile.fault.tolerance.tck.metrics.util.GaugeMetric
Allows tests to get the value of a
Gauge<Long>
and compare it with a baseline.
Most methods on this class will treat a non-existent gauge as having a value of zero to allow implementations to lazily create metrics.
Most tests should use MetricGetter
to create instances of this class.
-
Constructor Summary
ConstructorsConstructorDescriptionGaugeMetric
(MetricRegistryProxy registry, org.eclipse.microprofile.metrics.MetricID metricId) -
Method Summary
Modifier and TypeMethodDescriptionvoid
baseline()
Capture the current counter value for later comparison withdelta()
long
delta()
Return the difference between the current value of the metric and the value whenbaseline
was called.gauge()
Return the actualCounter
object for the metric, if it exists.long
value()
Get the counter value, or zero if the metric doesn't exist
-
Constructor Details
-
GaugeMetric
public GaugeMetric(MetricRegistryProxy registry, org.eclipse.microprofile.metrics.MetricID metricId)
-
-
Method Details
-
value
public long value()Get the counter value, or zero if the metric doesn't existThis method will not create the metric if it does not exist.
- Returns:
- the counter value, or zero if the metric doesn't exist
-
baseline
public void baseline()Capture the current counter value for later comparison withdelta()
This method will not create the metric if it does not exist.
-
delta
public long delta()Return the difference between the current value of the metric and the value whenbaseline
was called.- Returns:
- the difference between the metric value and the baseline
-
gauge
Return the actualCounter
object for the metric, if it exists.- Returns:
- an
Optional
containing theCounter
, or an emptyOptional
if the metric does not exist.
-