Package io.envoyproxy.envoy.extensions.load_balancing_policies.ring_hash.v3

Interface RingHashOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RingHash, RingHash.Builder
    public interface RingHashOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.UInt32Value getHashBalanceFactor()
      Configures percentage of average cluster load to bound per upstream host.
      com.google.protobuf.UInt32ValueOrBuilder getHashBalanceFactorOrBuilder()
      Configures percentage of average cluster load to bound per upstream host.
      RingHash.HashFunction getHashFunction()
      The hash function used to hash hosts onto the ketama ring.
      int getHashFunctionValue()
      The hash function used to hash hosts onto the ketama ring.
      com.google.protobuf.UInt64Value getMaximumRingSize()
      Maximum hash ring size.
      com.google.protobuf.UInt64ValueOrBuilder getMaximumRingSizeOrBuilder()
      Maximum hash ring size.
      com.google.protobuf.UInt64Value getMinimumRingSize()
      Minimum hash ring size.
      com.google.protobuf.UInt64ValueOrBuilder getMinimumRingSizeOrBuilder()
      Minimum hash ring size.
      boolean getUseHostnameForHashing()
      If set to `true`, the cluster will use hostname instead of the resolved address as the key to consistently hash to an upstream host.
      boolean hasHashBalanceFactor()
      Configures percentage of average cluster load to bound per upstream host.
      boolean hasMaximumRingSize()
      Maximum hash ring size.
      boolean hasMinimumRingSize()
      Minimum hash ring size.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getHashFunctionValue

        int getHashFunctionValue()
         The hash function used to hash hosts onto the ketama ring. The value defaults to
 :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
        .envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for hashFunction.

      • getHashFunction

        RingHash.HashFunction getHashFunction()
         The hash function used to hash hosts onto the ketama ring. The value defaults to
 :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
        .envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
        Returns:
        The hashFunction.

      • hasMinimumRingSize

        boolean hasMinimumRingSize()
         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
 :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
        .google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
        Returns:
        Whether the minimumRingSize field is set.

      • getMinimumRingSize

        com.google.protobuf.UInt64Value getMinimumRingSize()
         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
 :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
        .google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
        Returns:
        The minimumRingSize.

      • getMinimumRingSizeOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getMinimumRingSizeOrBuilder()
         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
 :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
        .google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }

      • hasMaximumRingSize

        boolean hasMaximumRingSize()
         Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered
 to further constrain resource use. See also
 :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
        .google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
        Returns:
        Whether the maximumRingSize field is set.

      • getMaximumRingSize

        com.google.protobuf.UInt64Value getMaximumRingSize()
         Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered
 to further constrain resource use. See also
 :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
        .google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
        Returns:
        The maximumRingSize.

      • getMaximumRingSizeOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getMaximumRingSizeOrBuilder()
         Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered
 to further constrain resource use. See also
 :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
        .google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }

      • getUseHostnameForHashing

        boolean getUseHostnameForHashing()
         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.
        bool use_hostname_for_hashing = 4;
        Returns:
        The useHostnameForHashing.

      • hasHashBalanceFactor

        boolean hasHashBalanceFactor()
         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.
        .google.protobuf.UInt32Value hash_balance_factor = 5 [(.validate.rules) = { ... }
        Returns:
        Whether the hashBalanceFactor field is set.

      • getHashBalanceFactor

        com.google.protobuf.UInt32Value getHashBalanceFactor()
         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.
        .google.protobuf.UInt32Value hash_balance_factor = 5 [(.validate.rules) = { ... }
        Returns:
        The hashBalanceFactor.

      • getHashBalanceFactorOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getHashBalanceFactorOrBuilder()
         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.
        .google.protobuf.UInt32Value hash_balance_factor = 5 [(.validate.rules) = { ... }