Package org.eclipse.microprofile.fault.tolerance.tck.telemetryMetrics.util

Class TelemetryMetricGetter

java.lang.Object

org.eclipse.microprofile.fault.tolerance.tck.telemetryMetrics.util.TelemetryMetricGetter

public class TelemetryMetricGetter
extends Object

Retrieves metrics for a specific method

The MetricGetter facilitates testing of metrics by providing helper methods for retrieving metrics defined by the faulttolerance spec for a specific class and method name.

This class will never create a metric which does not already exist.

Constructor Summary

Constructors

Constructor	Description
TelemetryMetricGetter(Class<?> clazz, String methodName)

Method Summary

Modifier and Type	Method	Description
void	baselineMetrics()	Calls baseline() on all relevant metrics.
TelemetryLongMetric	getBulkheadCalls(TelemetryMetricDefinition.BulkheadResult bulkheadResult)
TelemetryLongMetric	getBulkheadExecutionsRunning()
TelemetryLongMetric	getBulkheadExecutionsWaiting()
TelemetryHistogramMetric	getBulkheadRunningDuration()
TelemetryHistogramMetric	getBulkheadWaitingDuration()
TelemetryLongMetric	getCircuitBreakerCalls(TelemetryMetricDefinition.CircuitBreakerResult cbResult)
TelemetryLongMetric	getCircuitBreakerOpened()
TelemetryLongMetric	getCircuitBreakerState(TelemetryMetricDefinition.CircuitBreakerState cbState)
TelemetryLongMetric	getInvocations(TelemetryMetricDefinition.InvocationResult result, TelemetryMetricDefinition.InvocationFallback fallbackUsed)
TelemetryLongMetric	getRetryCalls(TelemetryMetricDefinition.RetryRetried retried, TelemetryMetricDefinition.RetryResult result)
TelemetryLongMetric	getRetryRetries()
static final TelemetryMetricDefinition.AttributeValue[][]	getTagCombinations(Class<? extends TelemetryMetricDefinition.AttributeValue>... tagValueClazzes)	Computes all possible values for a set of tags.
TelemetryLongMetric	getTimeoutCalls(TelemetryMetricDefinition.TimeoutTimedOut timedOut)
TelemetryHistogramMetric	getTimeoutExecutionDuration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TelemetryMetricGetter

public TelemetryMetricGetter(Class<?> clazz,
 String methodName)

Method Details

getInvocations

public TelemetryLongMetric getInvocations(TelemetryMetricDefinition.InvocationResult result,
 TelemetryMetricDefinition.InvocationFallback fallbackUsed)

getRetryCalls

public TelemetryLongMetric getRetryCalls(TelemetryMetricDefinition.RetryRetried retried,
 TelemetryMetricDefinition.RetryResult result)

getRetryRetries

public TelemetryLongMetric getRetryRetries()

getTimeoutCalls

public TelemetryLongMetric getTimeoutCalls(TelemetryMetricDefinition.TimeoutTimedOut timedOut)

getTimeoutExecutionDuration

public TelemetryHistogramMetric getTimeoutExecutionDuration()

getCircuitBreakerCalls

public TelemetryLongMetric getCircuitBreakerCalls(TelemetryMetricDefinition.CircuitBreakerResult cbResult)

getCircuitBreakerOpened

public TelemetryLongMetric getCircuitBreakerOpened()

getCircuitBreakerState

public TelemetryLongMetric getCircuitBreakerState(TelemetryMetricDefinition.CircuitBreakerState cbState)

getBulkheadCalls

public TelemetryLongMetric getBulkheadCalls(TelemetryMetricDefinition.BulkheadResult bulkheadResult)

getBulkheadExecutionsRunning

public TelemetryLongMetric getBulkheadExecutionsRunning()

getBulkheadExecutionsWaiting

public TelemetryLongMetric getBulkheadExecutionsWaiting()

getBulkheadRunningDuration

public TelemetryHistogramMetric getBulkheadRunningDuration()

getBulkheadWaitingDuration

public TelemetryHistogramMetric getBulkheadWaitingDuration()

baselineMetrics

public void baselineMetrics()

Calls baseline() on all relevant metrics.

Extracts all of the metrics which return long values from TelemetryMetricDefinition and calls TelemetryLongMetric.baseline() on them.

This allows us to check how they've changed later in the test using the TelemetryLongMetric.delta() method, without having to explicitly baseline every metric ourselves up front.

getTagCombinations

@SafeVarargs
public static final TelemetryMetricDefinition.AttributeValue[][] getTagCombinations(Class<? extends TelemetryMetricDefinition.AttributeValue>... tagValueClazzes)

Computes all possible values for a set of tags.

Given an array of TagValue enums, this method find every combination of values from across this set of tags.

For example, if we had two tags foo=[a|b] and bar=[x|y], this method would return

 [[foo=a, bar=x],
  [foo=a, bar=y],
  [foo=b, bar=x],
  [foo=b, bar=y]]
 

We can use this to iterate across all of the TelemetryMetricIDs which could be created for a metric which has multiple tags.

If called with no arguments, this method returns an array containing an empty array (indicating the only possible combination the the one with no tag values at all).

Parameters:

tagValueClazzes - the set of tags

Returns:

every possible combination when taking one value for each of the given tags