com.lightbend.lagom.internal.spi

Interface CircuitBreakerMetricsProvider

public interface CircuitBreakerMetricsProvider

Service Provider Interface (SPI) for collecting metrics from circuit breakers.

Method Summary

Modifier and Type	Method and Description
CircuitBreakerMetrics	start(java.lang.String breakerId) Start metrics collection for the circuit breaker with `breakerId` identifier.

Method Detail

start

CircuitBreakerMetrics start(java.lang.String breakerId)

Start metrics collection for the circuit breaker with `breakerId` identifier. Create (new or existing) instance of a CircuitBreakerMetrics that will be used for this circuit breaker instance.

The methods of the `CircuitBreakerMetrics` will be invoked when the circuit breaker is used or changes state. CircuitBreakerMetrics.stop() is called when the circuit breaker is removed, e.g. expired due to inactivity.

`stop` and `start` are also also invoked if the circuit breaker is re-configured.

Parameters:

breakerId - the identifider for the circuit breaker.

Returns:

the metrics for the circuit breaker with the given identifier