org.apache.camel.model

Class HystrixConfigurationCommon

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.HystrixConfigurationCommon

Direct Known Subclasses:

HystrixConfigurationDefinition

Deprecated.

@Deprecated
public class HystrixConfigurationCommon
extends IdentifiedType

Constructor Summary

Constructors

Constructor and Description
HystrixConfigurationCommon() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getAllowMaximumSizeToDivergeFromCoreSize() Deprecated.
String	getCircuitBreakerEnabled() Deprecated.
String	getCircuitBreakerErrorThresholdPercentage() Deprecated.
String	getCircuitBreakerForceClosed() Deprecated.
String	getCircuitBreakerForceOpen() Deprecated.
String	getCircuitBreakerRequestVolumeThreshold() Deprecated.
String	getCircuitBreakerSleepWindowInMilliseconds() Deprecated.
String	getCorePoolSize() Deprecated.
String	getExecutionIsolationSemaphoreMaxConcurrentRequests() Deprecated.
String	getExecutionIsolationStrategy() Deprecated.
String	getExecutionIsolationThreadInterruptOnTimeout() Deprecated.
String	getExecutionTimeoutEnabled() Deprecated.
String	getExecutionTimeoutInMilliseconds() Deprecated.
String	getFallbackEnabled() Deprecated.
String	getFallbackIsolationSemaphoreMaxConcurrentRequests() Deprecated.
String	getGroupKey() Deprecated.
String	getKeepAliveTime() Deprecated.
String	getMaximumSize() Deprecated.
String	getMaxQueueSize() Deprecated.
String	getMetricsHealthSnapshotIntervalInMilliseconds() Deprecated.
String	getMetricsRollingPercentileBucketSize() Deprecated.
String	getMetricsRollingPercentileEnabled() Deprecated.
String	getMetricsRollingPercentileWindowBuckets() Deprecated.
String	getMetricsRollingPercentileWindowInMilliseconds() Deprecated.
String	getMetricsRollingStatisticalWindowBuckets() Deprecated.
String	getMetricsRollingStatisticalWindowInMilliseconds() Deprecated.
String	getQueueSizeRejectionThreshold() Deprecated.
String	getRequestLogEnabled() Deprecated.
String	getThreadPoolKey() Deprecated.
String	getThreadPoolRollingNumberStatisticalWindowBuckets() Deprecated.
String	getThreadPoolRollingNumberStatisticalWindowInMilliseconds() Deprecated.
void	setAllowMaximumSizeToDivergeFromCoreSize(String allowMaximumSizeToDivergeFromCoreSize) Deprecated. Allows the configuration for maximumSize to take effect.
void	setCircuitBreakerEnabled(String circuitBreakerEnabled) Deprecated. Whether to use a HystrixCircuitBreaker or not.
void	setCircuitBreakerErrorThresholdPercentage(String circuitBreakerErrorThresholdPercentage) Deprecated. Error percentage threshold (as whole number such as 50) at which point the circuit breaker will trip open and reject requests.
void	setCircuitBreakerForceClosed(String circuitBreakerForceClosed) Deprecated. If true the HystrixCircuitBreaker#allowRequest() will always return true to allow requests regardless of the error percentage from HystrixCommandMetrics.getHealthCounts().
void	setCircuitBreakerForceOpen(String circuitBreakerForceOpen) Deprecated. If true the HystrixCircuitBreaker.allowRequest() will always return false, causing the circuit to be open (tripped) and reject all requests.
void	setCircuitBreakerRequestVolumeThreshold(String circuitBreakerRequestVolumeThreshold) Deprecated. Minimum number of requests in the metricsRollingStatisticalWindowInMilliseconds() that must exist before the HystrixCircuitBreaker will trip.
void	setCircuitBreakerSleepWindowInMilliseconds(String circuitBreakerSleepWindowInMilliseconds) Deprecated. The time in milliseconds after a HystrixCircuitBreaker trips open that it should wait before trying requests again.
void	setCorePoolSize(String corePoolSize) Deprecated. Core thread-pool size that gets passed to ThreadPoolExecutor.setCorePoolSize(int)
void	setExecutionIsolationSemaphoreMaxConcurrentRequests(String executionIsolationSemaphoreMaxConcurrentRequests) Deprecated. Number of concurrent requests permitted to HystrixCommand.run().
void	setExecutionIsolationStrategy(String executionIsolationStrategy) Deprecated. What isolation strategy HystrixCommand.run() will be executed with.
void	setExecutionIsolationThreadInterruptOnTimeout(String executionIsolationThreadInterruptOnTimeout) Deprecated. Whether the execution thread should attempt an interrupt (using Future.cancel(boolean)) when a thread times out.
void	setExecutionTimeoutEnabled(String executionTimeoutEnabled) Deprecated. Whether the timeout mechanism is enabled for this command
void	setExecutionTimeoutInMilliseconds(String executionTimeoutInMilliseconds) Deprecated. Time in milliseconds at which point the command will timeout and halt execution.
void	setFallbackEnabled(String fallbackEnabled) Deprecated. Whether HystrixCommand.getFallback() should be attempted when failure occurs.
void	setFallbackIsolationSemaphoreMaxConcurrentRequests(String fallbackIsolationSemaphoreMaxConcurrentRequests) Deprecated. Number of concurrent requests permitted to HystrixCommand.getFallback().
void	setGroupKey(String groupKey) Deprecated. Sets the group key to use.
void	setKeepAliveTime(String keepAliveTime) Deprecated. Keep-alive time in minutes that gets passed to ThreadPoolExecutor.setKeepAliveTime(long, TimeUnit)
void	setMaximumSize(String maximumSize) Deprecated. Maximum thread-pool size that gets passed to ThreadPoolExecutor.setMaximumPoolSize(int).
void	setMaxQueueSize(String maxQueueSize) Deprecated. Max queue size that gets passed to BlockingQueue in HystrixConcurrencyStrategy.getBlockingQueue(int) This should only affect the instantiation of a threadpool - it is not eliglible to change a queue size on the fly.
void	setMetricsHealthSnapshotIntervalInMilliseconds(String metricsHealthSnapshotIntervalInMilliseconds) Deprecated. Time in milliseconds to wait between allowing health snapshots to be taken that calculate success and error percentages and affect HystrixCircuitBreaker.isOpen() status.
void	setMetricsRollingPercentileBucketSize(String metricsRollingPercentileBucketSize) Deprecated. Maximum number of values stored in each bucket of the rolling percentile.
void	setMetricsRollingPercentileEnabled(String metricsRollingPercentileEnabled) Deprecated. Whether percentile metrics should be captured using HystrixRollingPercentile inside HystrixCommandMetrics.
void	setMetricsRollingPercentileWindowBuckets(String metricsRollingPercentileWindowBuckets) Deprecated. Number of buckets the rolling percentile window is broken into.
void	setMetricsRollingPercentileWindowInMilliseconds(String metricsRollingPercentileWindowInMilliseconds) Deprecated. Duration of percentile rolling window in milliseconds.
void	setMetricsRollingStatisticalWindowBuckets(String metricsRollingStatisticalWindowBuckets) Deprecated. Number of buckets the rolling statistical window is broken into.
void	setMetricsRollingStatisticalWindowInMilliseconds(String metricsRollingStatisticalWindowInMilliseconds) Deprecated. This property sets the duration of the statistical rolling window, in milliseconds.
void	setQueueSizeRejectionThreshold(String queueSizeRejectionThreshold) Deprecated. Queue size rejection threshold is an artificial "max" size at which rejections will occur even if maxQueueSize has not been reached.
void	setRequestLogEnabled(String requestLogEnabled) Deprecated. Whether HystrixCommand execution and events should be logged to HystrixRequestLog.
void	setThreadPoolKey(String threadPoolKey) Deprecated. Sets the thread pool key to use.
void	setThreadPoolRollingNumberStatisticalWindowBuckets(String threadPoolRollingNumberStatisticalWindowBuckets) Deprecated. Number of buckets the rolling statistical window is broken into.
void	setThreadPoolRollingNumberStatisticalWindowInMilliseconds(String threadPoolRollingNumberStatisticalWindowInMilliseconds) Deprecated. Duration of statistical rolling window in milliseconds.

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

HystrixConfigurationCommon

public HystrixConfigurationCommon()

Deprecated.

Method Detail

getGroupKey

public String getGroupKey()

Deprecated.

setGroupKey

public void setGroupKey(String groupKey)

Deprecated.

Sets the group key to use. The default value is CamelHystrix.

getThreadPoolKey

public String getThreadPoolKey()

Deprecated.

setThreadPoolKey

public void setThreadPoolKey(String threadPoolKey)

Deprecated.

Sets the thread pool key to use. Will by default use the same value as groupKey has been configured to use.

getCircuitBreakerEnabled

public String getCircuitBreakerEnabled()

Deprecated.

setCircuitBreakerEnabled

public void setCircuitBreakerEnabled(String circuitBreakerEnabled)

Deprecated.

Whether to use a HystrixCircuitBreaker or not. If false no circuit-breaker logic will be used and all requests permitted.

This is similar in effect to circuitBreakerForceClosed() except that continues tracking metrics and knowing whether it should be open/closed, this property results in not even instantiating a circuit-breaker.

getCircuitBreakerErrorThresholdPercentage

public String getCircuitBreakerErrorThresholdPercentage()

Deprecated.

setCircuitBreakerErrorThresholdPercentage

public void setCircuitBreakerErrorThresholdPercentage(String circuitBreakerErrorThresholdPercentage)

Deprecated.

Error percentage threshold (as whole number such as 50) at which point the circuit breaker will trip open and reject requests.

It will stay tripped for the duration defined in circuitBreakerSleepWindowInMilliseconds;

The error percentage this is compared against comes from HystrixCommandMetrics.getHealthCounts().

getCircuitBreakerForceClosed

public String getCircuitBreakerForceClosed()

Deprecated.

setCircuitBreakerForceClosed

public void setCircuitBreakerForceClosed(String circuitBreakerForceClosed)

Deprecated.

If true the HystrixCircuitBreaker#allowRequest() will always return true to allow requests regardless of the error percentage from HystrixCommandMetrics.getHealthCounts().

The circuitBreakerForceOpen() property takes precedence so if it set to true this property does nothing.

getCircuitBreakerForceOpen

public String getCircuitBreakerForceOpen()

Deprecated.

setCircuitBreakerForceOpen

public void setCircuitBreakerForceOpen(String circuitBreakerForceOpen)

Deprecated.

If true the HystrixCircuitBreaker.allowRequest() will always return false, causing the circuit to be open (tripped) and reject all requests.

This property takes precedence over circuitBreakerForceClosed();

getCircuitBreakerRequestVolumeThreshold

public String getCircuitBreakerRequestVolumeThreshold()

Deprecated.

setCircuitBreakerRequestVolumeThreshold

public void setCircuitBreakerRequestVolumeThreshold(String circuitBreakerRequestVolumeThreshold)

Deprecated.

Minimum number of requests in the metricsRollingStatisticalWindowInMilliseconds() that must exist before the HystrixCircuitBreaker will trip.

If below this number the circuit will not trip regardless of error percentage.

getCircuitBreakerSleepWindowInMilliseconds

public String getCircuitBreakerSleepWindowInMilliseconds()

Deprecated.

setCircuitBreakerSleepWindowInMilliseconds

public void setCircuitBreakerSleepWindowInMilliseconds(String circuitBreakerSleepWindowInMilliseconds)

Deprecated.

The time in milliseconds after a HystrixCircuitBreaker trips open that it should wait before trying requests again.

getExecutionIsolationSemaphoreMaxConcurrentRequests

public String getExecutionIsolationSemaphoreMaxConcurrentRequests()

Deprecated.

setExecutionIsolationSemaphoreMaxConcurrentRequests

public void setExecutionIsolationSemaphoreMaxConcurrentRequests(String executionIsolationSemaphoreMaxConcurrentRequests)

Deprecated.

Number of concurrent requests permitted to HystrixCommand.run(). Requests beyond the concurrent limit will be rejected.

Applicable only when executionIsolationStrategy == SEMAPHORE.

getExecutionIsolationStrategy

public String getExecutionIsolationStrategy()

Deprecated.

setExecutionIsolationStrategy

public void setExecutionIsolationStrategy(String executionIsolationStrategy)

Deprecated.

What isolation strategy HystrixCommand.run() will be executed with.

If THREAD then it will be executed on a separate thread and concurrent requests limited by the number of threads in the thread-pool.

If SEMAPHORE then it will be executed on the calling thread and concurrent requests limited by the semaphore count.

getExecutionIsolationThreadInterruptOnTimeout

public String getExecutionIsolationThreadInterruptOnTimeout()

Deprecated.

setExecutionIsolationThreadInterruptOnTimeout

public void setExecutionIsolationThreadInterruptOnTimeout(String executionIsolationThreadInterruptOnTimeout)

Deprecated.

Whether the execution thread should attempt an interrupt (using Future.cancel(boolean)) when a thread times out.

Applicable only when executionIsolationStrategy() == THREAD.

getExecutionTimeoutInMilliseconds

public String getExecutionTimeoutInMilliseconds()

Deprecated.

setExecutionTimeoutInMilliseconds

public void setExecutionTimeoutInMilliseconds(String executionTimeoutInMilliseconds)

Deprecated.

Time in milliseconds at which point the command will timeout and halt execution.

If executionIsolationThreadInterruptOnTimeout == true and the command is thread-isolated, the executing thread will be interrupted. If the command is semaphore-isolated and a HystrixObservableCommand, that command will get unsubscribed.

getExecutionTimeoutEnabled

public String getExecutionTimeoutEnabled()

Deprecated.

setExecutionTimeoutEnabled

public void setExecutionTimeoutEnabled(String executionTimeoutEnabled)

Deprecated.

Whether the timeout mechanism is enabled for this command

getFallbackIsolationSemaphoreMaxConcurrentRequests

public String getFallbackIsolationSemaphoreMaxConcurrentRequests()

Deprecated.

setFallbackIsolationSemaphoreMaxConcurrentRequests

public void setFallbackIsolationSemaphoreMaxConcurrentRequests(String fallbackIsolationSemaphoreMaxConcurrentRequests)

Deprecated.

Number of concurrent requests permitted to HystrixCommand.getFallback(). Requests beyond the concurrent limit will fail-fast and not attempt retrieving a fallback.

getFallbackEnabled

public String getFallbackEnabled()

Deprecated.

setFallbackEnabled

public void setFallbackEnabled(String fallbackEnabled)

Deprecated.

Whether HystrixCommand.getFallback() should be attempted when failure occurs.

getMetricsHealthSnapshotIntervalInMilliseconds

public String getMetricsHealthSnapshotIntervalInMilliseconds()

Deprecated.

setMetricsHealthSnapshotIntervalInMilliseconds

public void setMetricsHealthSnapshotIntervalInMilliseconds(String metricsHealthSnapshotIntervalInMilliseconds)

Deprecated.

Time in milliseconds to wait between allowing health snapshots to be taken that calculate success and error percentages and affect HystrixCircuitBreaker.isOpen() status.

On high-volume circuits the continual calculation of error percentage can become CPU intensive thus this controls how often it is calculated.

getMetricsRollingPercentileBucketSize

public String getMetricsRollingPercentileBucketSize()

Deprecated.

setMetricsRollingPercentileBucketSize

public void setMetricsRollingPercentileBucketSize(String metricsRollingPercentileBucketSize)

Deprecated.

Maximum number of values stored in each bucket of the rolling percentile. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

getMetricsRollingPercentileEnabled

public String getMetricsRollingPercentileEnabled()

Deprecated.

setMetricsRollingPercentileEnabled

public void setMetricsRollingPercentileEnabled(String metricsRollingPercentileEnabled)

Deprecated.

Whether percentile metrics should be captured using HystrixRollingPercentile inside HystrixCommandMetrics.

getMetricsRollingPercentileWindowInMilliseconds

public String getMetricsRollingPercentileWindowInMilliseconds()

Deprecated.

setMetricsRollingPercentileWindowInMilliseconds

public void setMetricsRollingPercentileWindowInMilliseconds(String metricsRollingPercentileWindowInMilliseconds)

Deprecated.

Duration of percentile rolling window in milliseconds. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

getMetricsRollingPercentileWindowBuckets

public String getMetricsRollingPercentileWindowBuckets()

Deprecated.

setMetricsRollingPercentileWindowBuckets

public void setMetricsRollingPercentileWindowBuckets(String metricsRollingPercentileWindowBuckets)

Deprecated.

Number of buckets the rolling percentile window is broken into. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

getMetricsRollingStatisticalWindowInMilliseconds

public String getMetricsRollingStatisticalWindowInMilliseconds()

Deprecated.

setMetricsRollingStatisticalWindowInMilliseconds

public void setMetricsRollingStatisticalWindowInMilliseconds(String metricsRollingStatisticalWindowInMilliseconds)

Deprecated.

This property sets the duration of the statistical rolling window, in milliseconds. This is how long metrics are kept for the thread pool. The window is divided into buckets and “rolls” by those increments.

getMetricsRollingStatisticalWindowBuckets

public String getMetricsRollingStatisticalWindowBuckets()

Deprecated.

setMetricsRollingStatisticalWindowBuckets

public void setMetricsRollingStatisticalWindowBuckets(String metricsRollingStatisticalWindowBuckets)

Deprecated.

Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside HystrixCommandMetrics.

getRequestLogEnabled

public String getRequestLogEnabled()

Deprecated.

setRequestLogEnabled

public void setRequestLogEnabled(String requestLogEnabled)

Deprecated.

Whether HystrixCommand execution and events should be logged to HystrixRequestLog.

getCorePoolSize

public String getCorePoolSize()

Deprecated.

setCorePoolSize

public void setCorePoolSize(String corePoolSize)

Deprecated.

Core thread-pool size that gets passed to ThreadPoolExecutor.setCorePoolSize(int)

getMaximumSize

public String getMaximumSize()

Deprecated.

setMaximumSize

public void setMaximumSize(String maximumSize)

Deprecated.

Maximum thread-pool size that gets passed to ThreadPoolExecutor.setMaximumPoolSize(int). This is the maximum amount of concurrency that can be supported without starting to reject HystrixCommands. Please note that this setting only takes effect if you also set allowMaximumSizeToDivergeFromCoreSize

getKeepAliveTime

public String getKeepAliveTime()

Deprecated.

setKeepAliveTime

public void setKeepAliveTime(String keepAliveTime)

Deprecated.

Keep-alive time in minutes that gets passed to ThreadPoolExecutor.setKeepAliveTime(long, TimeUnit)

getMaxQueueSize

public String getMaxQueueSize()

Deprecated.

setMaxQueueSize

public void setMaxQueueSize(String maxQueueSize)

Deprecated.

Max queue size that gets passed to BlockingQueue in HystrixConcurrencyStrategy.getBlockingQueue(int) This should only affect the instantiation of a threadpool - it is not eliglible to change a queue size on the fly. For that, use queueSizeRejectionThreshold().

getQueueSizeRejectionThreshold

public String getQueueSizeRejectionThreshold()

Deprecated.

setQueueSizeRejectionThreshold

public void setQueueSizeRejectionThreshold(String queueSizeRejectionThreshold)

Deprecated.

Queue size rejection threshold is an artificial "max" size at which rejections will occur even if maxQueueSize has not been reached. This is done because the maxQueueSize of a BlockingQueue can not be dynamically changed and we want to support dynamically changing the queue size that affects rejections.

This is used by HystrixCommand when queuing a thread for execution.

getThreadPoolRollingNumberStatisticalWindowInMilliseconds

public String getThreadPoolRollingNumberStatisticalWindowInMilliseconds()

Deprecated.

setThreadPoolRollingNumberStatisticalWindowInMilliseconds

public void setThreadPoolRollingNumberStatisticalWindowInMilliseconds(String threadPoolRollingNumberStatisticalWindowInMilliseconds)

Deprecated.

Duration of statistical rolling window in milliseconds. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance.

getThreadPoolRollingNumberStatisticalWindowBuckets

public String getThreadPoolRollingNumberStatisticalWindowBuckets()

Deprecated.

setThreadPoolRollingNumberStatisticalWindowBuckets

public void setThreadPoolRollingNumberStatisticalWindowBuckets(String threadPoolRollingNumberStatisticalWindowBuckets)

Deprecated.

Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance.

getAllowMaximumSizeToDivergeFromCoreSize

public String getAllowMaximumSizeToDivergeFromCoreSize()

Deprecated.

setAllowMaximumSizeToDivergeFromCoreSize

public void setAllowMaximumSizeToDivergeFromCoreSize(String allowMaximumSizeToDivergeFromCoreSize)

Deprecated.

Allows the configuration for maximumSize to take effect. That value can then be equal to, or higher, than coreSize