Module org.elasticsearch.server
Package org.elasticsearch.indices.breaker

Class CircuitBreakerService

java.lang.Object
org.elasticsearch.common.component.AbstractLifecycleComponent
org.elasticsearch.indices.breaker.CircuitBreakerService
All Implemented Interfaces:
Closeable, AutoCloseable, LifecycleComponent, Releasable
Direct Known Subclasses:
HierarchyCircuitBreakerService, NoneCircuitBreakerService, PreallocatedCircuitBreakerService
public abstract class CircuitBreakerService extends AbstractLifecycleComponent
Interface for Circuit Breaker services, which provide breakers to classes that load field data.

  • 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()
      Description copied from class: AbstractLifecycleComponent
      Start this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.

      If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.

      Specified by:
      doStart in class AbstractLifecycleComponent

    • doStop

      protected void doStop()
      Description copied from class: AbstractLifecycleComponent
      Stop this component. Typically that means doing the reverse of whatever AbstractLifecycleComponent.doStart() does.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after calling AbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.

      Specified by:
      doStop in class AbstractLifecycleComponent

    • doClose

      protected void doClose()
      Description copied from class: AbstractLifecycleComponent
      Close this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.

      Specified by:
      doClose in class AbstractLifecycleComponent