Package org.elasticsearch.plugins

Interface CircuitBreakerPlugin

public interface CircuitBreakerPlugin

An extension point for Plugin implementations to add custom circuit breakers

Method Summary

Modifier and Type	Method	Description
BreakerSettings	getCircuitBreaker(Settings settings)	Each of the factory functions are passed to the configured CircuitBreakerService.
void	setCircuitBreaker(CircuitBreaker circuitBreaker)	The passed CircuitBreaker object is the same one that was constructed by the BreakerSettings provided by getCircuitBreaker(Settings).

Method Details

getCircuitBreaker

BreakerSettings getCircuitBreaker(Settings settings)

Each of the factory functions are passed to the configured CircuitBreakerService. The service then constructs a CircuitBreaker given the resulting BreakerSettings. Custom circuit breakers settings can be found in BreakerSettings. See: - limit (example: `breaker.foo.limit`) BreakerSettings.CIRCUIT_BREAKER_LIMIT_SETTING - overhead (example: `breaker.foo.overhead`) BreakerSettings.CIRCUIT_BREAKER_OVERHEAD_SETTING - type (example: `breaker.foo.type`) BreakerSettings.CIRCUIT_BREAKER_TYPE The `limit` and `overhead` settings will be dynamically updated in the circuit breaker service iff a BreakerSettings object with the same name is provided at node startup.

setCircuitBreaker

void setCircuitBreaker(CircuitBreaker circuitBreaker)

The passed CircuitBreaker object is the same one that was constructed by the BreakerSettings provided by getCircuitBreaker(Settings). This reference should never change throughout the lifetime of the node.

Parameters:

circuitBreaker - The constructed CircuitBreaker object from the BreakerSettings provided by getCircuitBreaker(Settings)