io.greptime.rpc.limit

Class Gradient2Limit.Builder

java.lang.Object

io.greptime.rpc.limit.Gradient2Limit.Builder

Enclosing class:

Gradient2Limit

public static class Gradient2Limit.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Gradient2Limit	build()
Gradient2Limit.Builder	initialLimit(int initialLimit) Initial limit used by the limiter
Gradient2Limit.Builder	logOnLimitChange(boolean logOnLimitChange)
Gradient2Limit.Builder	longWindow(int n)
Gradient2Limit.Builder	maxConcurrency(int maxConcurrency) Maximum allowable concurrency.
Gradient2Limit.Builder	metricRegistry(com.netflix.concurrency.limits.MetricRegistry registry) Registry for reporting metrics about the limiter's internal state.
Gradient2Limit.Builder	minLimit(int minLimit) Minimum concurrency limit allowed.
Gradient2Limit.Builder	queueSize(java.util.function.Function<Integer,Integer> queueSize) Function to dynamically determine the amount the estimated limit can grow while latencies remain low as a function of the current limit.
Gradient2Limit.Builder	queueSize(int queueSize) Fixed amount the estimated limit can grow while latencies remain low
Gradient2Limit.Builder	rttTolerance(double rttTolerance) Tolerance for changes in minimum latency.
Gradient2Limit.Builder	smoothing(double smoothing) Smoothing factor to limit how aggressively the estimated limit can shrink when queuing has been detected.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

initialLimit

public Gradient2Limit.Builder initialLimit(int initialLimit)

Initial limit used by the limiter

Parameters:

initialLimit - initial limit

Returns:

Chainable builder

minLimit

public Gradient2Limit.Builder minLimit(int minLimit)

Minimum concurrency limit allowed. The minimum helps prevent the algorithm from adjust the limit too far down. Note that this limit is not desirable when use as backpressure for batch apps.

Parameters:

minLimit - minimum limit

Returns:

Chainable builder

maxConcurrency

public Gradient2Limit.Builder maxConcurrency(int maxConcurrency)

Maximum allowable concurrency. Any estimated concurrency will be capped at this value

Parameters:

maxConcurrency - maximum concurrency

Returns:

Chainable builder

queueSize

public Gradient2Limit.Builder queueSize(int queueSize)

Fixed amount the estimated limit can grow while latencies remain low

Parameters:

queueSize - fixed queue size

Returns:

Chainable builder

queueSize

public Gradient2Limit.Builder queueSize(java.util.function.Function<Integer,Integer> queueSize)

Function to dynamically determine the amount the estimated limit can grow while latencies remain low as a function of the current limit.

Parameters:

queueSize - function queue size

Returns:

Chainable builder

rttTolerance

public Gradient2Limit.Builder rttTolerance(double rttTolerance)

Tolerance for changes in minimum latency.

Parameters:

rttTolerance - Value >= 1.0 indicating how much change in minimum latency is acceptable before reducing the limit. For example, a value of 2.0 means that a 2x increase in latency is acceptable.

Returns:

Chainable builder

smoothing

public Gradient2Limit.Builder smoothing(double smoothing)

Smoothing factor to limit how aggressively the estimated limit can shrink when queuing has been detected.

Parameters:

smoothing - Value of 0.0 to 1.0 where 1.0 means the limit is completely replicated by the new estimate.

Returns:

Chainable builder

metricRegistry

public Gradient2Limit.Builder metricRegistry(com.netflix.concurrency.limits.MetricRegistry registry)

Registry for reporting metrics about the limiter's internal state.

Parameters:

registry - metric registry

Returns:

Chainable builder

longWindow

public Gradient2Limit.Builder longWindow(int n)

logOnLimitChange

public Gradient2Limit.Builder logOnLimitChange(boolean logOnLimitChange)

build

public Gradient2Limit build()