fish.payara.microprofile.faulttolerance

Interface FaultToleranceMetrics

public interface FaultToleranceMetrics

Encodes the specifics of the FT metrics names using default methods while decoupling rest of the implementation from the MetricRegistry. The metrics are bound to a specific invocation context which is not an argument to each of the provided methods but passed to the implementation upon construction. For another invocation another metrics instance is bound.

Author:

Jan Bernitt

Field Summary

Fields

Modifier and Type	Field and Description
static FaultToleranceMetrics	DISABLED Can be used as NULL object when metrics are disabled so avoid testing for enabled but still do essentially NOOPs.

Method Summary

Modifier and Type	Method and Description
default void	addBulkheadExecutionDuration(long duration)
default void	addBulkheadWaitingDuration(long duration)
default void	addTimeoutExecutionDuration(long duration)
default void	addToHistogram(String metric, long nanos) Histogram:
default void	incrementBulkheadCallsAcceptedTotal()
default void	incrementBulkheadCallsRejectedTotal()
default void	incrementCircuitbreakerCallsFailedTotal()
default void	incrementCircuitbreakerCallsPreventedTotal()
default void	incrementCircuitbreakerCallsSucceededTotal()
default void	incrementCircuitbreakerOpenedTotal()
default void	incrementCounter(String metric) Counters:
default void	incrementFallbackCallsTotal()
default void	incrementInvocationsFailedTotal()
default void	incrementInvocationsTotal()
default void	incrementRetryCallsFailedTotal()
default void	incrementRetryCallsSucceededNotRetriedTotal()
default void	incrementRetryCallsSucceededRetriedTotal()
default void	incrementRetryRetriesTotal()
default void	incrementTimeoutCallsNotTimedOutTotal()
default void	incrementTimeoutCallsTimedOutTotal()
default void	linkBulkheadConcurrentExecutions(LongSupplier gauge)
default void	linkBulkheadWaitingQueuePopulation(LongSupplier gauge)
default void	linkCircuitbreakerClosedTotal(LongSupplier gauge)
default void	linkCircuitbreakerHalfOpenTotal(LongSupplier gauge)
default void	linkCircuitbreakerOpenTotal(LongSupplier gauge)
default void	linkGauge(String metric, LongSupplier gauge) Gauge:

Field Detail

DISABLED

static final FaultToleranceMetrics DISABLED

Can be used as NULL object when metrics are disabled so avoid testing for enabled but still do essentially NOOPs.

Method Detail

incrementCounter

default void incrementCounter(String metric)

Counters:

Parameters:

metric - full name of the metric with %s used as placeholder for the method name

addToHistogram

default void addToHistogram(String metric,
                            long nanos)

Histogram:

Parameters:

metric - full name of the metric with %s used as placeholder for the method name

nanos - amount of nanoseconds to add to the histogram (>= 0)

linkGauge

default void linkGauge(String metric,
                       LongSupplier gauge)

Gauge:

Parameters:

metric - full name of the metric with%s used as placeholder for the method name

gauge - the gauge function to use in case the gauge is not already linked

incrementInvocationsTotal

default void incrementInvocationsTotal()

incrementInvocationsFailedTotal

default void incrementInvocationsFailedTotal()

incrementRetryCallsSucceededNotRetriedTotal

default void incrementRetryCallsSucceededNotRetriedTotal()

incrementRetryCallsSucceededRetriedTotal

default void incrementRetryCallsSucceededRetriedTotal()

incrementRetryCallsFailedTotal

default void incrementRetryCallsFailedTotal()

incrementRetryRetriesTotal

default void incrementRetryRetriesTotal()

addTimeoutExecutionDuration

default void addTimeoutExecutionDuration(long duration)

incrementTimeoutCallsTimedOutTotal

default void incrementTimeoutCallsTimedOutTotal()

incrementTimeoutCallsNotTimedOutTotal

default void incrementTimeoutCallsNotTimedOutTotal()

incrementCircuitbreakerCallsSucceededTotal

default void incrementCircuitbreakerCallsSucceededTotal()

incrementCircuitbreakerCallsFailedTotal

default void incrementCircuitbreakerCallsFailedTotal()

incrementCircuitbreakerCallsPreventedTotal

default void incrementCircuitbreakerCallsPreventedTotal()

incrementCircuitbreakerOpenedTotal

default void incrementCircuitbreakerOpenedTotal()

linkCircuitbreakerOpenTotal

default void linkCircuitbreakerOpenTotal(LongSupplier gauge)

linkCircuitbreakerHalfOpenTotal

default void linkCircuitbreakerHalfOpenTotal(LongSupplier gauge)

linkCircuitbreakerClosedTotal

default void linkCircuitbreakerClosedTotal(LongSupplier gauge)

incrementBulkheadCallsAcceptedTotal

default void incrementBulkheadCallsAcceptedTotal()

incrementBulkheadCallsRejectedTotal

default void incrementBulkheadCallsRejectedTotal()

linkBulkheadConcurrentExecutions

default void linkBulkheadConcurrentExecutions(LongSupplier gauge)

linkBulkheadWaitingQueuePopulation

default void linkBulkheadWaitingQueuePopulation(LongSupplier gauge)

addBulkheadExecutionDuration

default void addBulkheadExecutionDuration(long duration)

addBulkheadWaitingDuration

default void addBulkheadWaitingDuration(long duration)

incrementFallbackCallsTotal

default void incrementFallbackCallsTotal()