Package io.envoyproxy.envoy.api.v2.endpoint

Class UpstreamLocalityStats

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpstreamLocalityStatsOrBuilder, Serializable
    public final class UpstreamLocalityStats
extends com.google.protobuf.GeneratedMessageV3
implements UpstreamLocalityStatsOrBuilder
     These are stats Envoy reports to GLB every so often. Report frequency is
 defined by
 :ref:`LoadStatsResponse.load_reporting_interval<envoy_api_field_service.load_stats.v2.LoadStatsResponse.load_reporting_interval>`.
 Stats per upstream region/zone and optionally per subzone.
 [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.
 [#next-free-field: 9]
    Protobuf type envoy.api.v2.endpoint.UpstreamLocalityStats
    See Also:
    Serialized Form

    • Field Detail

      • TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER

        public static final int TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER

        public static final int TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_ERROR_REQUESTS_FIELD_NUMBER

        public static final int TOTAL_ERROR_REQUESTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_ISSUED_REQUESTS_FIELD_NUMBER

        public static final int TOTAL_ISSUED_REQUESTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_METRIC_STATS_FIELD_NUMBER

        public static final int LOAD_METRIC_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER

        public static final int UPSTREAM_ENDPOINT_STATS_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

      • hasLocality

        public boolean hasLocality()
         Name of zone, region and optionally endpoint group these metrics were
 collected from. Zone and region names could be empty if unknown.
        .envoy.api.v2.core.Locality locality = 1;
        Specified by:
        hasLocality in interface UpstreamLocalityStatsOrBuilder
        Returns:
        Whether the locality field is set.

      • getLocality

        public Locality getLocality()
         Name of zone, region and optionally endpoint group these metrics were
 collected from. Zone and region names could be empty if unknown.
        .envoy.api.v2.core.Locality locality = 1;
        Specified by:
        getLocality in interface UpstreamLocalityStatsOrBuilder
        Returns:
        The locality.

      • getTotalSuccessfulRequests

        public long getTotalSuccessfulRequests()
         The total number of requests successfully completed by the endpoints in the
 locality.
        uint64 total_successful_requests = 2;
        Specified by:
        getTotalSuccessfulRequests in interface UpstreamLocalityStatsOrBuilder
        Returns:
        The totalSuccessfulRequests.

      • getTotalErrorRequests

        public long getTotalErrorRequests()
         The total number of requests that failed due to errors at the endpoint,
 aggregated over all endpoints in the locality.
        uint64 total_error_requests = 4;
        Specified by:
        getTotalErrorRequests in interface UpstreamLocalityStatsOrBuilder
        Returns:
        The totalErrorRequests.

      • getTotalIssuedRequests

        public long getTotalIssuedRequests()
         The total number of requests that were issued by this Envoy since
 the last report. This information is aggregated over all the
 upstream endpoints in the locality.
        uint64 total_issued_requests = 8;
        Specified by:
        getTotalIssuedRequests in interface UpstreamLocalityStatsOrBuilder
        Returns:
        The totalIssuedRequests.

      • getLoadMetricStatsCount

        public int getLoadMetricStatsCount()
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;
        Specified by:
        getLoadMetricStatsCount in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsList

        public List<UpstreamEndpointStats> getUpstreamEndpointStatsList()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsList in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsOrBuilderList

        public List<? extends UpstreamEndpointStatsOrBuilder> getUpstreamEndpointStatsOrBuilderList()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsOrBuilderList in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsCount

        public int getUpstreamEndpointStatsCount()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsCount in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStats

        public UpstreamEndpointStats getUpstreamEndpointStats​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStats in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsOrBuilder

        public UpstreamEndpointStatsOrBuilder getUpstreamEndpointStatsOrBuilder​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsOrBuilder in interface UpstreamLocalityStatsOrBuilder

      • getPriority

        public int getPriority()
         [#not-implemented-hide:] The priority of the endpoint group these metrics
 were collected from.
        uint32 priority = 6;
        Specified by:
        getPriority in interface UpstreamLocalityStatsOrBuilder
        Returns:
        The priority.

      • 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 UpstreamLocalityStats parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<UpstreamLocalityStats> 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 UpstreamLocalityStats getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder