Package org.apache.camel.model

Class HystrixConfigurationDefinition

  • @Metadata(label="configuration,eip")
@Configurer(extended=true)
@Deprecated
public class HystrixConfigurationDefinition
extends HystrixConfigurationCommon
    Deprecated.
    Hystrix Circuit Breaker EIP configuration

    • Constructor Detail

      • HystrixConfigurationDefinition

        public HystrixConfigurationDefinition()
        Deprecated.

      • HystrixConfigurationDefinition

        public HystrixConfigurationDefinition​(CircuitBreakerDefinition parent)
        Deprecated.

    • Method Detail

      • threadPoolKey

        public HystrixConfigurationDefinition threadPoolKey​(String threadPoolKey)
        Deprecated.
        Sets the thread pool key to use. Will by default use the same value as groupKey has been configured to use.

      • circuitBreakerEnabled

        public HystrixConfigurationDefinition circuitBreakerEnabled​(boolean 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.

      • circuitBreakerErrorThresholdPercentage

        public HystrixConfigurationDefinition circuitBreakerErrorThresholdPercentage​(int 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().

      • circuitBreakerForceClosed

        public HystrixConfigurationDefinition circuitBreakerForceClosed​(boolean 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.

      • circuitBreakerForceOpen

        public HystrixConfigurationDefinition circuitBreakerForceOpen​(boolean 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();

      • circuitBreakerRequestVolumeThreshold

        public HystrixConfigurationDefinition circuitBreakerRequestVolumeThreshold​(int 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.

      • circuitBreakerSleepWindowInMilliseconds

        public HystrixConfigurationDefinition circuitBreakerSleepWindowInMilliseconds​(int circuitBreakerSleepWindowInMilliseconds)
        Deprecated.
        The time in milliseconds after a HystrixCircuitBreaker trips open that it should wait before trying requests again.

      • executionIsolationSemaphoreMaxConcurrentRequests

        public HystrixConfigurationDefinition executionIsolationSemaphoreMaxConcurrentRequests​(int executionIsolationSemaphoreMaxConcurrentRequests)
        Deprecated.
        Number of concurrent requests permitted to HystrixCommand.run(). Requests beyond the concurrent limit will be rejected.

        Applicable only when executionIsolationStrategy is SEMAPHORE.

      • executionIsolationStrategy

        public HystrixConfigurationDefinition executionIsolationStrategy​(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.

      • executionIsolationThreadInterruptOnTimeout

        public HystrixConfigurationDefinition executionIsolationThreadInterruptOnTimeout​(boolean executionIsolationThreadInterruptOnTimeout)
        Deprecated.
        Whether the execution thread should attempt an interrupt (using Future cancel) when a thread times out.

        Applicable only when executionIsolationStrategy() is set to THREAD.

      • executionTimeoutInMilliseconds

        public HystrixConfigurationDefinition executionTimeoutInMilliseconds​(int executionTimeoutInMilliseconds)
        Deprecated.
        Time in milliseconds at which point the command will timeout and halt execution.

        If executionIsolationThreadInterruptOnTimeout is 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.

      • executionTimeoutEnabled

        public HystrixConfigurationDefinition executionTimeoutEnabled​(boolean executionTimeoutEnabled)
        Deprecated.
        Whether the timeout mechanism is enabled for this command

      • fallbackIsolationSemaphoreMaxConcurrentRequests

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

      • fallbackEnabled

        public HystrixConfigurationDefinition fallbackEnabled​(boolean fallbackEnabled)
        Deprecated.
        Whether HystrixCommand.getFallback() should be attempted when failure occurs.

      • metricsHealthSnapshotIntervalInMilliseconds

        public HystrixConfigurationDefinition metricsHealthSnapshotIntervalInMilliseconds​(int 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.

      • metricsRollingPercentileBucketSize

        public HystrixConfigurationDefinition metricsRollingPercentileBucketSize​(int metricsRollingPercentileBucketSize)
        Deprecated.
        Maximum number of values stored in each bucket of the rolling percentile. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

      • metricsRollingPercentileEnabled

        public HystrixConfigurationDefinition metricsRollingPercentileEnabled​(boolean metricsRollingPercentileEnabled)
        Deprecated.
        Whether percentile metrics should be captured using HystrixRollingPercentile inside HystrixCommandMetrics.

      • metricsRollingPercentileWindowInMilliseconds

        public HystrixConfigurationDefinition metricsRollingPercentileWindowInMilliseconds​(int metricsRollingPercentileWindowInMilliseconds)
        Deprecated.
        Duration of percentile rolling window in milliseconds. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

      • metricsRollingPercentileWindowBuckets

        public HystrixConfigurationDefinition metricsRollingPercentileWindowBuckets​(int metricsRollingPercentileWindowBuckets)
        Deprecated.
        Number of buckets the rolling percentile window is broken into. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics.

      • metricsRollingStatisticalWindowInMilliseconds

        public HystrixConfigurationDefinition metricsRollingStatisticalWindowInMilliseconds​(int 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.

      • metricsRollingStatisticalWindowBuckets

        public HystrixConfigurationDefinition metricsRollingStatisticalWindowBuckets​(int metricsRollingStatisticalWindowBuckets)
        Deprecated.
        Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside HystrixCommandMetrics.

      • requestLogEnabled

        public HystrixConfigurationDefinition requestLogEnabled​(boolean requestLogEnabled)
        Deprecated.
        Whether HystrixCommand execution and events should be logged to HystrixRequestLog.

      • maxQueueSize

        public HystrixConfigurationDefinition maxQueueSize​(int maxQueueSize)
        Deprecated.
        Max queue size. This should only affect the instantiation of the thread-pool - it is not eligible to change a queue size on the fly.

      • maximumSize

        public HystrixConfigurationDefinition maximumSize​(int 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

      • queueSizeRejectionThreshold

        public HystrixConfigurationDefinition queueSizeRejectionThreshold​(int 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 blocking queue 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.

      • threadPoolRollingNumberStatisticalWindowInMilliseconds

        public HystrixConfigurationDefinition threadPoolRollingNumberStatisticalWindowInMilliseconds​(int threadPoolRollingNumberStatisticalWindowInMilliseconds)
        Deprecated.
        Duration of statistical rolling window in milliseconds. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance.

      • threadPoolRollingNumberStatisticalWindowBuckets

        public HystrixConfigurationDefinition threadPoolRollingNumberStatisticalWindowBuckets​(int threadPoolRollingNumberStatisticalWindowBuckets)
        Deprecated.
        Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance.

      • allowMaximumSizeToDivergeFromCoreSize

        public HystrixConfigurationDefinition allowMaximumSizeToDivergeFromCoreSize​(boolean allowMaximumSizeToDivergeFromCoreSize)
        Deprecated.
        Allows the configuration for maximumSize to take effect. That value can then be equal to, or higher, than coreSize