Package org.elasticsearch.indices.breaker

Class HierarchyCircuitBreakerService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.indices.breaker.CircuitBreakerService

org.elasticsearch.indices.breaker.HierarchyCircuitBreakerService

All Implemented Interfaces:

Closeable, AutoCloseable, LifecycleComponent, Releasable

public class HierarchyCircuitBreakerService
extends CircuitBreakerService

CircuitBreakerService that attempts to redistribute space between breakers if tripped

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<ByteSizeValue>	ACCOUNTING_CIRCUIT_BREAKER_LIMIT_SETTING
static Setting<Double>	ACCOUNTING_CIRCUIT_BREAKER_OVERHEAD_SETTING
static Setting<CircuitBreaker.Type>	ACCOUNTING_CIRCUIT_BREAKER_TYPE_SETTING
static Setting<ByteSizeValue>	FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING
static Setting<Double>	FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING
static Setting<CircuitBreaker.Type>	FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING
static Setting<ByteSizeValue>	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING
static Setting<Double>	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING
static Setting<CircuitBreaker.Type>	IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING
static Setting<ByteSizeValue>	REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING
static Setting<Double>	REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING
static Setting<CircuitBreaker.Type>	REQUEST_CIRCUIT_BREAKER_TYPE_SETTING
static Setting<ByteSizeValue>	TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING
static Setting<Boolean>	USE_REAL_MEMORY_USAGE_SETTING

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
HierarchyCircuitBreakerService(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
void	checkParentLimit(long newBytesReserved, 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 java.lang.Object

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

Field Detail

USE_REAL_MEMORY_USAGE_SETTING

public static final Setting<Boolean> USE_REAL_MEMORY_USAGE_SETTING

TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting<ByteSizeValue> TOTAL_CIRCUIT_BREAKER_LIMIT_SETTING

FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting<ByteSizeValue> FIELDDATA_CIRCUIT_BREAKER_LIMIT_SETTING

FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final Setting<Double> FIELDDATA_CIRCUIT_BREAKER_OVERHEAD_SETTING

FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING

public static final Setting<CircuitBreaker.Type> FIELDDATA_CIRCUIT_BREAKER_TYPE_SETTING

REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting<ByteSizeValue> REQUEST_CIRCUIT_BREAKER_LIMIT_SETTING

REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final Setting<Double> REQUEST_CIRCUIT_BREAKER_OVERHEAD_SETTING

REQUEST_CIRCUIT_BREAKER_TYPE_SETTING

public static final Setting<CircuitBreaker.Type> REQUEST_CIRCUIT_BREAKER_TYPE_SETTING

ACCOUNTING_CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting<ByteSizeValue> ACCOUNTING_CIRCUIT_BREAKER_LIMIT_SETTING

ACCOUNTING_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final Setting<Double> ACCOUNTING_CIRCUIT_BREAKER_OVERHEAD_SETTING

ACCOUNTING_CIRCUIT_BREAKER_TYPE_SETTING

public static final Setting<CircuitBreaker.Type> ACCOUNTING_CIRCUIT_BREAKER_TYPE_SETTING

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting<ByteSizeValue> IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_LIMIT_SETTING

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final Setting<Double> IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_OVERHEAD_SETTING

IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING

public static final Setting<CircuitBreaker.Type> IN_FLIGHT_REQUESTS_CIRCUIT_BREAKER_TYPE_SETTING

Constructor Detail

HierarchyCircuitBreakerService

public HierarchyCircuitBreakerService(Settings settings,
                                      ClusterSettings clusterSettings)

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(long newBytesReserved,
                             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