org.elasticsearch.common.breaker

クラス MemoryCircuitBreaker

java.lang.Object

org.elasticsearch.common.breaker.MemoryCircuitBreaker

すべての実装されたインタフェース:

CircuitBreaker

public class MemoryCircuitBreaker
extends Object
implements CircuitBreaker

MemoryCircuitBreaker is a circuit breaker that breaks once a configurable memory limit has been reached.

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.breaker.CircuitBreaker

CircuitBreaker.Type

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.breaker.CircuitBreaker

FIELDDATA, PARENT, REQUEST

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MemoryCircuitBreaker(ByteSizeValue limit, double overheadConstant, ESLogger logger) Create a circuit breaker that will break if the number of estimated bytes grows above the limit.
MemoryCircuitBreaker(ByteSizeValue limit, double overheadConstant, MemoryCircuitBreaker oldBreaker, ESLogger logger) Create a circuit breaker that will break if the number of estimated bytes grows above the limit.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
double	addEstimateBytesAndMaybeBreak(long bytes, String label) Add a number of bytes, tripping the circuit breaker if the aggregated estimates are above the limit.
long	addWithoutBreaking(long bytes) Add an exact number of bytes, not checking for tripping the circuit breaker.
void	circuitBreak(String fieldName, long bytesNeeded) Method used to trip the breaker
long	getLimit()
String	getName()
double	getOverhead()
long	getTrippedCount()
long	getUsed()

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

MemoryCircuitBreaker

public MemoryCircuitBreaker(ByteSizeValue limit,
                            double overheadConstant,
                            ESLogger logger)

Create a circuit breaker that will break if the number of estimated bytes grows above the limit. All estimations will be multiplied by the given overheadConstant. This breaker starts with 0 bytes used.

パラメータ:

limit - circuit breaker limit

overheadConstant - constant multiplier for byte estimations

MemoryCircuitBreaker

public MemoryCircuitBreaker(ByteSizeValue limit,
                            double overheadConstant,
                            MemoryCircuitBreaker oldBreaker,
                            ESLogger logger)

Create a circuit breaker that will break if the number of estimated bytes grows above the limit. All estimations will be multiplied by the given overheadConstant. Uses the given oldBreaker to initialize the starting offset.

パラメータ:

limit - circuit breaker limit

overheadConstant - constant multiplier for byte estimations

oldBreaker - the previous circuit breaker to inherit the used value from (starting offset)

メソッドの詳細

circuitBreak

public void circuitBreak(String fieldName,
                         long bytesNeeded)
                  throws CircuitBreakingException

Method used to trip the breaker

定義:

circuitBreak インタフェース内 CircuitBreaker

パラメータ:

fieldName - name of the field responsible for tripping the breaker

bytesNeeded - bytes asked for but unable to be allocated

例外:

CircuitBreakingException

addEstimateBytesAndMaybeBreak

public double addEstimateBytesAndMaybeBreak(long bytes,
                                            String label)
                                     throws CircuitBreakingException

Add a number of bytes, tripping the circuit breaker if the aggregated estimates are above the limit. Automatically trips the breaker if the memory limit is set to 0. Will never trip the breaker if the limit is set < 0, but can still be used to aggregate estimations.

定義:

addEstimateBytesAndMaybeBreak インタフェース内 CircuitBreaker

パラメータ:

bytes - number of bytes to add to the breaker

label - string label describing the bytes being added

戻り値:

number of "used" bytes so far

例外:

CircuitBreakingException

addWithoutBreaking

public long addWithoutBreaking(long bytes)

Add an exact number of bytes, not checking for tripping the circuit breaker. This bypasses the overheadConstant multiplication.

定義:

addWithoutBreaking インタフェース内 CircuitBreaker

パラメータ:

bytes - number of bytes to add to the breaker

戻り値:

number of "used" bytes so far

getUsed

public long getUsed()

定義:

getUsed インタフェース内 CircuitBreaker

戻り値:

the number of aggregated "used" bytes so far

getLimit

public long getLimit()

定義:

getLimit インタフェース内 CircuitBreaker

戻り値:

the number of bytes that can be added before the breaker trips

getOverhead

public double getOverhead()

定義:

getOverhead インタフェース内 CircuitBreaker

戻り値:

the constant multiplier the breaker uses for aggregations

getTrippedCount

public long getTrippedCount()

定義:

getTrippedCount インタフェース内 CircuitBreaker

戻り値:

the number of times the breaker has been tripped

getName

public String getName()

定義:

getName インタフェース内 CircuitBreaker

戻り値:

the name of the breaker