org.elasticsearch.indices.breaker

Class HierarchyCircuitBreakerService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<CircuitBreakerService>

org.elasticsearch.indices.breaker.CircuitBreakerService

org.elasticsearch.indices.breaker.HierarchyCircuitBreakerService

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<CircuitBreakerService>, Releasable

public class HierarchyCircuitBreakerService
extends CircuitBreakerService

CircuitBreakerService that attempts to redistribute space between breakers if tripped

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HierarchyCircuitBreakerService.ApplySettings

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BREAKER_TYPE
static String	DEFAULT_FIELDDATA_BREAKER_LIMIT
static double	DEFAULT_FIELDDATA_OVERHEAD_CONSTANT
static String	DEFAULT_IN_FLIGHT_REQUESTS_BREAKER_LIMIT
static String	DEFAULT_REQUEST_BREAKER_LIMIT
static String	DEFAULT_TOTAL_CIRCUIT_BREAKER_LIMIT
static String	FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING
static String	FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING
static String	FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING
static String	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING
static String	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING
static String	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING
static String	OLD_CIRCUIT_BREAKER_MAX_BYTES_SETTING
static String	OLD_CIRCUIT_BREAKER_OVERHEAD_SETTING
static String	REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING
static String	REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING
static String	REQUEST_CIRCUIT_BREAKER_TYPE_SETTING
static String	TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
HierarchyCircuitBreakerService(Settings settings, NodeSettingsService nodeSettingsService)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkParentLimit(String label) Checks whether the parent breaker has been tripped
CircuitBreaker	getBreaker(String name)
void	registerBreaker(BreakerSettings breakerSettings) Allows to register a custom circuit breaker.
AllCircuitBreakerStats	stats()
CircuitBreakerStats	stats(String name)
static void	validateSettings(BreakerSettings[] childrenSettings) Validate that child settings are valid

Methods inherited from class org.elasticsearch.indices.breaker.CircuitBreakerService

doClose, doStart, doStop

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

OLD_CIRCUIT_BREAKER_MAX_BYTES_SETTING

public static final String OLD_CIRCUIT_BREAKER_MAX_BYTES_SETTING

See Also:

Constant Field Values

OLD_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final String OLD_CIRCUIT_BREAKER_OVERHEAD_SETTING

See Also:

Constant Field Values

TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING

public static final String TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING

See Also:

Constant Field Values

DEFAULT_TOTAL_CIRCUIT_BREAKER_LIMIT

public static final String DEFAULT_TOTAL_CIRCUIT_BREAKER_LIMIT

See Also:

Constant Field Values

FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING

public static final String FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING

See Also:

Constant Field Values

FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final String FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING

See Also:

Constant Field Values

FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING

public static final String FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING

See Also:

Constant Field Values

DEFAULT_FIELDDATA_BREAKER_LIMIT

public static final String DEFAULT_FIELDDATA_BREAKER_LIMIT

See Also:

Constant Field Values

DEFAULT_FIELDDATA_OVERHEAD_CONSTANT

public static final double DEFAULT_FIELDDATA_OVERHEAD_CONSTANT

See Also:

Constant Field Values

REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING

public static final String REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING

See Also:

Constant Field Values

REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final String REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING

See Also:

Constant Field Values

REQUEST_CIRCUIT_BREAKER_TYPE_SETTING

public static final String REQUEST_CIRCUIT_BREAKER_TYPE_SETTING

See Also:

Constant Field Values

DEFAULT_REQUEST_BREAKER_LIMIT

public static final String DEFAULT_REQUEST_BREAKER_LIMIT

See Also:

Constant Field Values

DEFAULT_BREAKER_TYPE

public static final String DEFAULT_BREAKER_TYPE

See Also:

Constant Field Values

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING

public static final String IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING

See Also:

Constant Field Values

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final String IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING

See Also:

Constant Field Values

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING

public static final String IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING

See Also:

Constant Field Values

DEFAULT_IN_FLIGHT_REQUESTS_BREAKER_LIMIT

public static final String DEFAULT_IN_FLIGHT_REQUESTS_BREAKER_LIMIT

See Also:

Constant Field Values

Constructor Detail

HierarchyCircuitBreakerService

@Inject
public HierarchyCircuitBreakerService(Settings settings,
                                     NodeSettingsService nodeSettingsService)

Method Detail

validateSettings

public static void validateSettings(BreakerSettings[] childrenSettings)
                             throws IllegalStateException

Validate that child settings are valid

Throws:

IllegalStateException

getBreaker

public CircuitBreaker getBreaker(String name)

Specified by:

getBreaker in class CircuitBreakerService

Returns:

the breaker that can be used to register estimates against

stats

public AllCircuitBreakerStats stats()

Specified by:

stats in class CircuitBreakerService

Returns:

stats about all breakers

stats

public CircuitBreakerStats stats(String name)

Specified by:

stats in class CircuitBreakerService

Returns:

stats about a specific breaker

checkParentLimit

public void checkParentLimit(String label)
                      throws CircuitBreakingException

Checks whether the parent breaker has been tripped

Throws:

CircuitBreakingException

registerBreaker

public void registerBreaker(BreakerSettings breakerSettings)

Allows to register a custom circuit breaker. Warning: Will overwrite any existing custom breaker with the same name.

Specified by:

registerBreaker in class CircuitBreakerService