Package org.apache.solr.util.circuitbreaker

Class CPUCircuitBreaker

java.lang.Object

org.apache.solr.util.circuitbreaker.CircuitBreaker

org.apache.solr.util.circuitbreaker.CPUCircuitBreaker

All Implemented Interfaces:

Closeable, AutoCloseable, NamedListInitializedPlugin

public class CPUCircuitBreaker
extends CircuitBreaker

Tracks current CPU usage and triggers if the specified threshold is breached.

This circuit breaker gets the recent average CPU usage and uses that data to take a decision. We depend on OperatingSystemMXBean which does not allow a configurable interval of collection of data.

Constructor Summary

Constructors

Constructor	Description
CPUCircuitBreaker(SolrCore core)

Method Summary

Modifier and Type	Method	Description
protected double	calculateLiveCPUUsage()	Calculate the CPU usage for the system in percentage.
double	getCpuUsageThreshold()
String	getErrorMessage()	Get error message when the circuit breaker triggers
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.
boolean	isTripped()	Check if circuit breaker is tripped.
void	setThreshold(double thresholdValueInPercentage)

Methods inherited from class org.apache.solr.util.circuitbreaker.CircuitBreaker

close, getErrorCode, getRequestTypes, setRequestTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

CPUCircuitBreaker

public CPUCircuitBreaker(SolrCore core)

Method Detail

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class CircuitBreaker

Parameters:

args - non-null list of initialization parameters (may be empty)

isTripped

public boolean isTripped()

Description copied from class: CircuitBreaker

Check if circuit breaker is tripped.

Specified by:

isTripped in class CircuitBreaker

getErrorMessage

public String getErrorMessage()

Description copied from class: CircuitBreaker

Get error message when the circuit breaker triggers

Specified by:

getErrorMessage in class CircuitBreaker

setThreshold

public void setThreshold(double thresholdValueInPercentage)

getCpuUsageThreshold

public double getCpuUsageThreshold()

calculateLiveCPUUsage

protected double calculateLiveCPUUsage()

Calculate the CPU usage for the system in percentage.

Returns:

Percent CPU usage of -1 if value could not be obtained.