Interface TrackClusterStatsOrBuilder

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

    public interface TrackClusterStatsOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getPerEndpointStats()
      If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters`` output.
      boolean getRequestResponseSizes()
      If request_response_sizes is true, then the :ref:`histograms <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes of requests and responses will be published.
      boolean getTimeoutBudgets()
      If timeout_budgets is true, the :ref:`timeout budget histograms <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each request.
      • 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

      • getTimeoutBudgets

        boolean getTimeoutBudgets()
         If timeout_budgets is true, the :ref:`timeout budget histograms
         <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
         request. These show what percentage of a request's per try and global timeout was used. A value
         of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
         of 100 would indicate that the request took the entirety of the timeout given to it.
         
        bool timeout_budgets = 1;
        Returns:
        The timeoutBudgets.
      • getRequestResponseSizes

        boolean getRequestResponseSizes()
         If request_response_sizes is true, then the :ref:`histograms
         <config_cluster_manager_cluster_stats_request_response_sizes>`  tracking header and body sizes
         of requests and responses will be published.
         
        bool request_response_sizes = 2;
        Returns:
        The requestResponseSizes.
      • getPerEndpointStats

        boolean getPerEndpointStats()
         If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
         output.
        
         This does not currently output correct stats during a hot-restart.
        
         This is not currently implemented by all stat sinks.
        
         These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
         <envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
         endpoint filtering is supported.
        
         This may not be used at the same time as
         :ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
         
        bool per_endpoint_stats = 3;
        Returns:
        The perEndpointStats.