Package io.envoyproxy.envoy.config.endpoint.v3

Class UpstreamLocalityStats

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.endpoint.v3.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 the management server at a frequency defined by
 :ref:`LoadStatsResponse.load_reporting_interval<envoy_v3_api_field_service.load_stats.v3.LoadStatsResponse.load_reporting_interval>`.
 Stats per upstream region/zone and optionally per subzone.
 [#next-free-field: 15]
Protobuf type envoy.config.endpoint.v3.UpstreamLocalityStats
See Also:

  • Field Details

    • LOCALITY_FIELD_NUMBER

      public static final int LOCALITY_FIELD_NUMBER
      See Also:

    • TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER

      public static final int TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER
      See Also:

    • TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER

      public static final int TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER
      See Also:

    • TOTAL_ERROR_REQUESTS_FIELD_NUMBER

      public static final int TOTAL_ERROR_REQUESTS_FIELD_NUMBER
      See Also:

    • TOTAL_ISSUED_REQUESTS_FIELD_NUMBER

      public static final int TOTAL_ISSUED_REQUESTS_FIELD_NUMBER
      See Also:

    • TOTAL_ACTIVE_CONNECTIONS_FIELD_NUMBER

      public static final int TOTAL_ACTIVE_CONNECTIONS_FIELD_NUMBER
      See Also:

    • TOTAL_NEW_CONNECTIONS_FIELD_NUMBER

      public static final int TOTAL_NEW_CONNECTIONS_FIELD_NUMBER
      See Also:

    • TOTAL_FAIL_CONNECTIONS_FIELD_NUMBER

      public static final int TOTAL_FAIL_CONNECTIONS_FIELD_NUMBER
      See Also:

    • CPU_UTILIZATION_FIELD_NUMBER

      public static final int CPU_UTILIZATION_FIELD_NUMBER
      See Also:

    • MEM_UTILIZATION_FIELD_NUMBER

      public static final int MEM_UTILIZATION_FIELD_NUMBER
      See Also:

    • APPLICATION_UTILIZATION_FIELD_NUMBER

      public static final int APPLICATION_UTILIZATION_FIELD_NUMBER
      See Also:

    • LOAD_METRIC_STATS_FIELD_NUMBER

      public static final int LOAD_METRIC_STATS_FIELD_NUMBER
      See Also:

    • UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER

      public static final int UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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.config.core.v3.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.config.core.v3.Locality locality = 1;
      Specified by:
      getLocality in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The locality.

    • getLocalityOrBuilder

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

    • 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.

    • getTotalRequestsInProgress

      public long getTotalRequestsInProgress()
       The total number of unfinished requests. A request can be an HTTP request
 or a TCP connection for a TCP connection pool.
      uint64 total_requests_in_progress = 3;
      Specified by:
      getTotalRequestsInProgress in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The totalRequestsInProgress.

    • 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. A request can be an HTTP request
 or a TCP connection for a TCP connection pool.
      uint64 total_issued_requests = 8;
      Specified by:
      getTotalIssuedRequests in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The totalIssuedRequests.

    • getTotalActiveConnections

      public long getTotalActiveConnections()
       The total number of connections in an established state at the time of the
 report. This field is aggregated over all the upstream endpoints in the
 locality.
 In Envoy, this information may be based on ``upstream_cx_active metric``.
 [#not-implemented-hide:]
      uint64 total_active_connections = 9 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      getTotalActiveConnections in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The totalActiveConnections.

    • getTotalNewConnections

      public long getTotalNewConnections()
       The total number of connections opened since the last report.
 This field is aggregated over all the upstream endpoints in the locality.
 In Envoy, this information may be based on ``upstream_cx_total`` metric
 compared to itself between start and end of an interval, i.e.
 ``upstream_cx_total``(now) - ``upstream_cx_total``(now -
 load_report_interval).
 [#not-implemented-hide:]
      uint64 total_new_connections = 10 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      getTotalNewConnections in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The totalNewConnections.

    • getTotalFailConnections

      public long getTotalFailConnections()
       The total number of connection failures since the last report.
 This field is aggregated over all the upstream endpoints in the locality.
 In Envoy, this information may be based on ``upstream_cx_connect_fail``
 metric compared to itself between start and end of an interval, i.e.
 ``upstream_cx_connect_fail``(now) - ``upstream_cx_connect_fail``(now -
 load_report_interval).
 [#not-implemented-hide:]
      uint64 total_fail_connections = 11 [(.xds.annotations.v3.field_status) = { ... }
      Specified by:
      getTotalFailConnections in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The totalFailConnections.

    • hasCpuUtilization

      public boolean hasCpuUtilization()
       CPU utilization stats for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats cpu_utilization = 12;
      Specified by:
      hasCpuUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      Whether the cpuUtilization field is set.

    • getCpuUtilization

      public UnnamedEndpointLoadMetricStats getCpuUtilization()
       CPU utilization stats for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats cpu_utilization = 12;
      Specified by:
      getCpuUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The cpuUtilization.

    • getCpuUtilizationOrBuilder

      public UnnamedEndpointLoadMetricStatsOrBuilder getCpuUtilizationOrBuilder()
       CPU utilization stats for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats cpu_utilization = 12;
      Specified by:
      getCpuUtilizationOrBuilder in interface UpstreamLocalityStatsOrBuilder

    • hasMemUtilization

      public boolean hasMemUtilization()
       Memory utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats mem_utilization = 13;
      Specified by:
      hasMemUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      Whether the memUtilization field is set.

    • getMemUtilization

      public UnnamedEndpointLoadMetricStats getMemUtilization()
       Memory utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats mem_utilization = 13;
      Specified by:
      getMemUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The memUtilization.

    • getMemUtilizationOrBuilder

      public UnnamedEndpointLoadMetricStatsOrBuilder getMemUtilizationOrBuilder()
       Memory utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats mem_utilization = 13;
      Specified by:
      getMemUtilizationOrBuilder in interface UpstreamLocalityStatsOrBuilder

    • hasApplicationUtilization

      public boolean hasApplicationUtilization()
       Blended application-defined utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats application_utilization = 14;
      Specified by:
      hasApplicationUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      Whether the applicationUtilization field is set.

    • getApplicationUtilization

      public UnnamedEndpointLoadMetricStats getApplicationUtilization()
       Blended application-defined utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats application_utilization = 14;
      Specified by:
      getApplicationUtilization in interface UpstreamLocalityStatsOrBuilder
      Returns:
      The applicationUtilization.

    • getApplicationUtilizationOrBuilder

      public UnnamedEndpointLoadMetricStatsOrBuilder getApplicationUtilizationOrBuilder()
       Blended application-defined utilization for multi-dimensional load balancing.
 This typically comes from endpoint metrics reported via ORCA.
      .envoy.config.endpoint.v3.UnnamedEndpointLoadMetricStats application_utilization = 14;
      Specified by:
      getApplicationUtilizationOrBuilder in interface UpstreamLocalityStatsOrBuilder

    • getLoadMetricStatsList

      public List<EndpointLoadMetricStats> getLoadMetricStatsList()
       Named stats for multi-dimensional load balancing.
 These typically come from endpoint metrics reported via ORCA.
      repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      Specified by:
      getLoadMetricStatsList in interface UpstreamLocalityStatsOrBuilder

    • getLoadMetricStatsOrBuilderList

      public List<? extends EndpointLoadMetricStatsOrBuilder> getLoadMetricStatsOrBuilderList()
       Named stats for multi-dimensional load balancing.
 These typically come from endpoint metrics reported via ORCA.
      repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      Specified by:
      getLoadMetricStatsOrBuilderList in interface UpstreamLocalityStatsOrBuilder

    • getLoadMetricStatsCount

      public int getLoadMetricStatsCount()
       Named stats for multi-dimensional load balancing.
 These typically come from endpoint metrics reported via ORCA.
      repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      Specified by:
      getLoadMetricStatsCount in interface UpstreamLocalityStatsOrBuilder

    • getLoadMetricStats

      public EndpointLoadMetricStats getLoadMetricStats(int index)
       Named stats for multi-dimensional load balancing.
 These typically come from endpoint metrics reported via ORCA.
      repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      Specified by:
      getLoadMetricStats in interface UpstreamLocalityStatsOrBuilder

    • getLoadMetricStatsOrBuilder

      public EndpointLoadMetricStatsOrBuilder getLoadMetricStatsOrBuilder(int index)
       Named stats for multi-dimensional load balancing.
 These typically come from endpoint metrics reported via ORCA.
      repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      Specified by:
      getLoadMetricStatsOrBuilder 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_v3_api_field_service.load_stats.v3.LoadStatsResponse.report_endpoint_granularity>`.
      repeated .envoy.config.endpoint.v3.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_v3_api_field_service.load_stats.v3.LoadStatsResponse.report_endpoint_granularity>`.
      repeated .envoy.config.endpoint.v3.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_v3_api_field_service.load_stats.v3.LoadStatsResponse.report_endpoint_granularity>`.
      repeated .envoy.config.endpoint.v3.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_v3_api_field_service.load_stats.v3.LoadStatsResponse.report_endpoint_granularity>`.
      repeated .envoy.config.endpoint.v3.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_v3_api_field_service.load_stats.v3.LoadStatsResponse.report_endpoint_granularity>`.
      repeated .envoy.config.endpoint.v3.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

    • parseFrom

      public static UpstreamLocalityStats parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpstreamLocalityStats parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpstreamLocalityStats parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpstreamLocalityStats parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpstreamLocalityStats parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpstreamLocalityStats parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static UpstreamLocalityStats.Builder newBuilder()

    • newBuilder

      public static UpstreamLocalityStats.Builder newBuilder(UpstreamLocalityStats prototype)

    • 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

    • getDefaultInstance

      public static UpstreamLocalityStats getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpstreamLocalityStats> parser()

    • 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