Package org.opensearch.core.common.breaker

Class NoopCircuitBreaker

java.lang.Object

org.opensearch.core.common.breaker.NoopCircuitBreaker

All Implemented Interfaces:

CircuitBreaker

public class NoopCircuitBreaker
extends Object
implements CircuitBreaker

A CircuitBreaker that doesn't increment or adjust, and all operations are basically noops. It never trips, limit is always -1, always returns 0 for all metrics.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.common.breaker.CircuitBreaker

CircuitBreaker.Durability, CircuitBreaker.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LIMIT	The limit of this breaker is always -1

Fields inherited from interface org.opensearch.core.common.breaker.CircuitBreaker

FIELDDATA, IN_FLIGHT_REQUESTS, PARENT, REQUEST

Constructor Summary

Constructors

Constructor	Description
NoopCircuitBreaker(String name)	Creates a new NoopCircuitBreaker (that never trip) with the given name

Method Summary

Modifier and Type	Method	Description
double	addEstimateBytesAndMaybeBreak(long bytes, String label)	This is a noop, always return 0 and never throw/trip
long	addWithoutBreaking(long bytes)	This is a noop, nothing is added, always return 0
void	circuitBreak(String fieldName, long bytesNeeded)	This is a noop, a noop breaker never trip
CircuitBreaker.Durability	getDurability()	A noop breaker CircuitBreaker.Durability is always CircuitBreaker.Durability.PERMANENT
long	getLimit()	A noop breaker have a constant limit of -1
String	getName()	return the name of this breaker
double	getOverhead()	A noop breaker have no overhead, always return 0
long	getTrippedCount()	A noop breaker never trip, always return 0
long	getUsed()	This is a noop, always return 0
void	setLimitAndOverhead(long limit, double overhead)	Limit and overhead are constant for a noop breaker.

Methods inherited from class java.lang.Object

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

Field Details

LIMIT

public static final int LIMIT

The limit of this breaker is always -1

See Also:

• Constant Field Values

Constructor Details

NoopCircuitBreaker

public NoopCircuitBreaker(String name)

Creates a new NoopCircuitBreaker (that never trip) with the given name

Parameters:

name - the name of this breaker

Method Details

circuitBreak

public void circuitBreak(String fieldName,
 long bytesNeeded)

This is a noop, a noop breaker never trip

Specified by:

circuitBreak in interface CircuitBreaker

Parameters:

fieldName - name of this noop breaker

bytesNeeded - bytes needed

addEstimateBytesAndMaybeBreak

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

This is a noop, always return 0 and never throw/trip

Specified by:

addEstimateBytesAndMaybeBreak in interface CircuitBreaker

Parameters:

bytes - number of bytes to add

label - string label describing the bytes being added

Returns:

always return 0

Throws:

CircuitBreakingException - never thrown

addWithoutBreaking

public long addWithoutBreaking(long bytes)

This is a noop, nothing is added, always return 0

Specified by:

addWithoutBreaking in interface CircuitBreaker

Parameters:

bytes - number of bytes to add (ignored)

Returns:

always return 0

getUsed

public long getUsed()

This is a noop, always return 0

Specified by:

getUsed in interface CircuitBreaker

Returns:

always return 0

getLimit

public long getLimit()

A noop breaker have a constant limit of -1

Specified by:

getLimit in interface CircuitBreaker

Returns:

always return -1

getOverhead

public double getOverhead()

A noop breaker have no overhead, always return 0

Specified by:

getOverhead in interface CircuitBreaker

Returns:

always return 0

getTrippedCount

public long getTrippedCount()

A noop breaker never trip, always return 0

Specified by:

getTrippedCount in interface CircuitBreaker

Returns:

always return 0

getName

public String getName()

return the name of this breaker

Specified by:

getName in interface CircuitBreaker

Returns:

the name of this breaker

getDurability

public CircuitBreaker.Durability getDurability()

A noop breaker CircuitBreaker.Durability is always CircuitBreaker.Durability.PERMANENT

Specified by:

getDurability in interface CircuitBreaker

Returns:

always return CircuitBreaker.Durability.PERMANENT

setLimitAndOverhead

public void setLimitAndOverhead(long limit,
 double overhead)

Limit and overhead are constant for a noop breaker. this is a noop.

Specified by:

setLimitAndOverhead in interface CircuitBreaker

Parameters:

limit - the desired limit (ignored)

overhead - the desired overhead (ignored)