org.apache.samza.table.remote

Class TableRateLimiter<K,V>

java.lang.Object

org.apache.samza.table.remote.TableRateLimiter<K,V>

Type Parameters:

K - type of the table key

V - type of the table record

public class TableRateLimiter<K,V>
extends java.lang.Object

Helper class for remote table to throttle table IO requests with the configured rate limiter. For each request, the needed credits are calculated with the configured credit functions. The throttle methods are overloaded to support the possible CRUD operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TableRateLimiter.CreditFunction<K,V> Function interface for providing rate limiting credits for each table record.

Constructor Summary

Constructors

Constructor and Description
TableRateLimiter(java.lang.String tableId, RateLimiter rateLimiter, TableRateLimiter.CreditFunction<K,V> creditFn, java.lang.String tag)

Method Summary

Modifier and Type	Method and Description
void	setTimerMetric(Timer timer) Set up waitTimeMetric metric for latency reporting due to throttling.
void	throttle(java.util.Collection<K> keys, java.lang.Object... args) Throttle a request with a collection of keys as the argument if necessary.
void	throttle(int opId, java.lang.Object... args) Throttle a request with opId and associated arguments
void	throttle(K key, java.lang.Object... args) Throttle a request with a key argument if necessary.
void	throttle(K key, V value, java.lang.Object... args) Throttle a request with both the key and value arguments if necessary.
void	throttleRecords(java.util.Collection<Entry<K,V>> records, java.lang.Object... args) Throttle a request with a collection of table records as the argument if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableRateLimiter

public TableRateLimiter(java.lang.String tableId,
                        RateLimiter rateLimiter,
                        TableRateLimiter.CreditFunction<K,V> creditFn,
                        java.lang.String tag)

Parameters:

tableId - table id of the table to be rate limited

rateLimiter - actual rate limiter instance to be used

creditFn - function for deriving the credits for each request

tag - tag to be used with the rate limiter

Method Detail

setTimerMetric

public void setTimerMetric(Timer timer)

Set up waitTimeMetric metric for latency reporting due to throttling.

Parameters:

timer - waitTimeMetric metric

throttle

public void throttle(K key,
                     java.lang.Object... args)

Throttle a request with a key argument if necessary.

Parameters:

key - key used for the table request

args - additional arguments

throttle

public void throttle(K key,
                     V value,
                     java.lang.Object... args)

Throttle a request with both the key and value arguments if necessary.

Parameters:

key - key used for the table request

value - value used for the table request

args - additional arguments

throttle

public void throttle(int opId,
                     java.lang.Object... args)

Throttle a request with opId and associated arguments

Parameters:

opId - operation Id

args - associated arguments

throttle

public void throttle(java.util.Collection<K> keys,
                     java.lang.Object... args)

Throttle a request with a collection of keys as the argument if necessary.

Parameters:

keys - collection of keys used for the table request

args - additional arguments

throttleRecords

public void throttleRecords(java.util.Collection<Entry<K,V>> records,
                            java.lang.Object... args)

Throttle a request with a collection of table records as the argument if necessary.

Parameters:

records - collection of records used for the table request

args - additional arguments