Module org.elasticsearch.server

Package org.elasticsearch.indices.breaker

Class HierarchyCircuitBreakerService

java.lang.Object

org.elasticsearch.indices.breaker.CircuitBreakerService

org.elasticsearch.indices.breaker.HierarchyCircuitBreakerService

public class HierarchyCircuitBreakerService
extends CircuitBreakerService

CircuitBreakerService that attempts to redistribute space between breakers if tripped

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
HierarchyCircuitBreakerService(CircuitBreakerMetrics metrics, Settings settings, List<BreakerSettings> customBreakers, 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)
org.elasticsearch.indices.breaker.HierarchyCircuitBreakerService.OverLimitStrategy	getOverLimitStrategy()
long	getParentLimit()
boolean	isTrackRealMemoryUsage()
AllCircuitBreakerStats	stats()
CircuitBreakerStats	stats(String name)
void	updateUseRealMemorySetting(boolean trackRealMemoryUsage)
static void	validateSettings(BreakerSettings[] childrenSettings)	Validate that child settings are valid

Methods inherited from class java.lang.Object

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

Field Details

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

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 Details

HierarchyCircuitBreakerService

public HierarchyCircuitBreakerService(CircuitBreakerMetrics metrics,
 Settings settings,
 List<BreakerSettings> customBreakers,
 ClusterSettings clusterSettings)

Method Details

updateUseRealMemorySetting

public void updateUseRealMemorySetting(boolean trackRealMemoryUsage)

isTrackRealMemoryUsage

public boolean isTrackRealMemoryUsage()

getOverLimitStrategy

public org.elasticsearch.indices.breaker.HierarchyCircuitBreakerService.OverLimitStrategy getOverLimitStrategy()

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

getParentLimit

public long getParentLimit()

checkParentLimit

public void checkParentLimit(long newBytesReserved,
 String label)
                      throws CircuitBreakingException

Checks whether the parent breaker has been tripped

Throws:

CircuitBreakingException