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

Class ConsistentHashingLbConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ConsistentHashingLbConfigOrBuilder, Serializable
    public final class ConsistentHashingLbConfig
extends com.google.protobuf.GeneratedMessageV3
implements ConsistentHashingLbConfigOrBuilder
     Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
    Protobuf type envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig
    See Also:
    Serialized Form

    • Field Detail

      • USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER

        public static final int USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HASH_BALANCE_FACTOR_FIELD_NUMBER

        public static final int HASH_BALANCE_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getUseHostnameForHashing

        public 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 = 1;
        Specified by:
        getUseHostnameForHashing in interface ConsistentHashingLbConfigOrBuilder
        Returns:
        The useHostnameForHashing.

      • hasHashBalanceFactor

        public 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.
 Applies to both Ring Hash and Maglev load balancers.
 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 = 2 [(.validate.rules) = { ... }
        Specified by:
        hasHashBalanceFactor in interface ConsistentHashingLbConfigOrBuilder
        Returns:
        Whether the hashBalanceFactor field is set.

      • getHashBalanceFactor

        public 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.
 Applies to both Ring Hash and Maglev load balancers.
 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 = 2 [(.validate.rules) = { ... }
        Specified by:
        getHashBalanceFactor in interface ConsistentHashingLbConfigOrBuilder
        Returns:
        The hashBalanceFactor.

      • getHashBalanceFactorOrBuilder

        public 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.
 Applies to both Ring Hash and Maglev load balancers.
 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 = 2 [(.validate.rules) = { ... }
        Specified by:
        getHashBalanceFactorOrBuilder in interface ConsistentHashingLbConfigOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConsistentHashingLbConfig parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ConsistentHashingLbConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ConsistentHashingLbConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ConsistentHashingLbConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ConsistentHashingLbConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ConsistentHashingLbConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder