Package org.opensearch.core.indices.breaker

Class CircuitBreakerService

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

org.opensearch.core.indices.breaker.CircuitBreakerService

All Implemented Interfaces:

Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent

Direct Known Subclasses:

NoneCircuitBreakerService

@PublicApi(since="1.0.0")
public abstract class CircuitBreakerService
extends org.opensearch.common.lifecycle.AbstractLifecycleComponent

Interface for Circuit Breaker services, which provide breakers to classes that load field data.

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CircuitBreakerService()

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
protected void	doStart()
protected void	doStop()
abstract CircuitBreaker	getBreaker(String name)
abstract AllCircuitBreakerStats	stats()
abstract CircuitBreakerStats	stats(String name)

Methods inherited from class org.opensearch.common.lifecycle.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

Constructor Details

CircuitBreakerService

protected CircuitBreakerService()

Method Details

getBreaker

public abstract CircuitBreaker getBreaker(String name)

Returns:

the breaker that can be used to register estimates against

stats

public abstract AllCircuitBreakerStats stats()

Returns:

stats about all breakers

stats

public abstract CircuitBreakerStats stats(String name)

Returns:

stats about a specific breaker

doStart

protected void doStart()

Specified by:

doStart in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class org.opensearch.common.lifecycle.AbstractLifecycleComponent