Interface UpstreamLocalityStatsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    UpstreamLocalityStats, UpstreamLocalityStats.Builder

    public interface UpstreamLocalityStatsOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • hasLocality

        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;
        Returns:
        Whether the locality field is set.
      • getLocality

        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;
        Returns:
        The locality.
      • getLocalityOrBuilder

        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;
      • getTotalSuccessfulRequests

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

        long getTotalRequestsInProgress()
         The total number of unfinished requests
         
        uint64 total_requests_in_progress = 3;
        Returns:
        The totalRequestsInProgress.
      • getTotalErrorRequests

        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;
        Returns:
        The totalErrorRequests.
      • getTotalIssuedRequests

        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;
        Returns:
        The totalIssuedRequests.
      • getTotalActiveConnections

        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) = { ... }
        Returns:
        The totalActiveConnections.
      • getTotalNewConnections

        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) = { ... }
        Returns:
        The totalNewConnections.
      • getTotalFailConnections

        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) = { ... }
        Returns:
        The totalFailConnections.
      • getLoadMetricStatsList

        java.util.List<EndpointLoadMetricStats> getLoadMetricStatsList()
         Stats for multi-dimensional load balancing.
         
        repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      • getLoadMetricStats

        EndpointLoadMetricStats getLoadMetricStats​(int index)
         Stats for multi-dimensional load balancing.
         
        repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      • getLoadMetricStatsCount

        int getLoadMetricStatsCount()
         Stats for multi-dimensional load balancing.
         
        repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      • getLoadMetricStatsOrBuilderList

        java.util.List<? extends EndpointLoadMetricStatsOrBuilder> getLoadMetricStatsOrBuilderList()
         Stats for multi-dimensional load balancing.
         
        repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      • getLoadMetricStatsOrBuilder

        EndpointLoadMetricStatsOrBuilder getLoadMetricStatsOrBuilder​(int index)
         Stats for multi-dimensional load balancing.
         
        repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
      • getUpstreamEndpointStatsList

        java.util.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;
      • getUpstreamEndpointStats

        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;
      • getUpstreamEndpointStatsCount

        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;
      • getUpstreamEndpointStatsOrBuilderList

        java.util.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;
      • getUpstreamEndpointStatsOrBuilder

        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;
      • getPriority

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