Ring Hash Load Balancing Policy (proto)

This extension has the qualified name envoy.load_balancing_policies.ring_hash

Note

This extension is intended to be robust against both untrusted downstream and upstream traffic.

Tip

This extension extends and can be used with the following extension category:

envoy.load_balancing_policies

This extension must be configured with one of the following type URLs:

type.googleapis.com/envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash

extensions.load_balancing_policies.ring_hash.v3.RingHash

[extensions.load_balancing_policies.ring_hash.v3.RingHash proto]

This configuration allows the built-in RING_HASH LB policy to be configured via the LB policy extension point. See the load balancing architecture overview for more information.

{
  "hash_function": ...,
  "minimum_ring_size": {...},
  "maximum_ring_size": {...},
  "use_hostname_for_hashing": ...,
  "hash_balance_factor": {...},
  "consistent_hashing_lb_config": {...},
  "locality_weighted_lb_config": {...}
}

hash_function: (extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction) The hash function used to hash hosts onto the ketama ring. The value defaults to XX_HASH.

minimum_ring_size: (UInt64Value) Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also maximum_ring_size.

maximum_ring_size: (UInt64Value) Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also minimum_ring_size.

use_hostname_for_hashing

(bool) If set to true, the cluster will use hostname instead of the resolved address as the key to consistently hash to an upstream host. Only valid for StrictDNS clusters with hostnames which resolve to a single IP address.

..note::: This is deprecated and please use consistent_hashing_lb_config instead.

hash_balance_factor

(UInt32Value) Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster. If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200. Minimum is 100.

This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified hash_balance_factor, requests to any upstream host are capped at hash_balance_factor/100 times the average number of requests across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the cascading overflow effect when choosing the next host in the ring/table).

If weights are specified on the hosts, they are respected.

This is an O(N) algorithm, unlike other load balancers. Using a lower hash_balance_factor results in more hosts being probed, so use a higher value if you require better performance.

..note::: This is deprecated and please use consistent_hashing_lb_config instead.

consistent_hashing_lb_config: (extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig) Common configuration for hashing-based load balancing policies.

locality_weighted_lb_config: (extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig) Enable locality weighted load balancing for ring hash lb explicitly.

Enum extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction

[extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction proto]

The hash function used to hash hosts onto the ketama ring.

DEFAULT_HASH: (DEFAULT) ⁣Currently defaults to XX_HASH.

XX_HASH: ⁣Use xxHash.

MURMUR_HASH_2: ⁣Use MurmurHash2, this is compatible with std:hash<string> in GNU libstdc++ 3.4.20 or above. This is typically the case when compiled on Linux and not macOS.