Class ClusterStats

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterStatsOrBuilder, java.io.Serializable

    public final class ClusterStats
    extends com.google.protobuf.GeneratedMessage
    implements ClusterStatsOrBuilder
     Per cluster load stats. Envoy reports these stats a management server in a
     :ref:`LoadStatsRequest<envoy_v3_api_msg_service.load_stats.v3.LoadStatsRequest>`
     Next ID: 7
     [#next-free-field: 7]
     
    Protobuf type envoy.config.endpoint.v3.ClusterStats
    See Also:
    Serialized Form
    • Field Detail

      • bitField0_

        private int bitField0_
      • CLUSTER_NAME_FIELD_NUMBER

        public static final int CLUSTER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • clusterName_

        private volatile java.lang.Object clusterName_
      • CLUSTER_SERVICE_NAME_FIELD_NUMBER

        public static final int CLUSTER_SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • clusterServiceName_

        private volatile java.lang.Object clusterServiceName_
      • UPSTREAM_LOCALITY_STATS_FIELD_NUMBER

        public static final int UPSTREAM_LOCALITY_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TOTAL_DROPPED_REQUESTS_FIELD_NUMBER

        public static final int TOTAL_DROPPED_REQUESTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • totalDroppedRequests_

        private long totalDroppedRequests_
      • DROPPED_REQUESTS_FIELD_NUMBER

        public static final int DROPPED_REQUESTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LOAD_REPORT_INTERVAL_FIELD_NUMBER

        public static final int LOAD_REPORT_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values
      • loadReportInterval_

        private com.google.protobuf.Duration loadReportInterval_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final ClusterStats DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<ClusterStats> PARSER
    • Constructor Detail

      • ClusterStats

        private ClusterStats​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • ClusterStats

        private ClusterStats()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • getClusterName

        public java.lang.String getClusterName()
         The name of the cluster.
         
        string cluster_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getClusterName in interface ClusterStatsOrBuilder
        Returns:
        The clusterName.
      • getClusterNameBytes

        public com.google.protobuf.ByteString getClusterNameBytes()
         The name of the cluster.
         
        string cluster_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getClusterNameBytes in interface ClusterStatsOrBuilder
        Returns:
        The bytes for clusterName.
      • getClusterServiceName

        public java.lang.String getClusterServiceName()
         The eds_cluster_config service_name of the cluster.
         It's possible that two clusters send the same service_name to EDS,
         in that case, the management server is supposed to do aggregation on the load reports.
         
        string cluster_service_name = 6;
        Specified by:
        getClusterServiceName in interface ClusterStatsOrBuilder
        Returns:
        The clusterServiceName.
      • getClusterServiceNameBytes

        public com.google.protobuf.ByteString getClusterServiceNameBytes()
         The eds_cluster_config service_name of the cluster.
         It's possible that two clusters send the same service_name to EDS,
         in that case, the management server is supposed to do aggregation on the load reports.
         
        string cluster_service_name = 6;
        Specified by:
        getClusterServiceNameBytes in interface ClusterStatsOrBuilder
        Returns:
        The bytes for clusterServiceName.
      • getUpstreamLocalityStatsCount

        public int getUpstreamLocalityStatsCount()
         Need at least one.
         
        repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
        Specified by:
        getUpstreamLocalityStatsCount in interface ClusterStatsOrBuilder
      • getTotalDroppedRequests

        public long getTotalDroppedRequests()
         Cluster-level stats such as total_successful_requests may be computed by
         summing upstream_locality_stats. In addition, below there are additional
         cluster-wide stats.
        
         The total number of dropped requests. This covers requests
         deliberately dropped by the drop_overload policy and circuit breaking.
         
        uint64 total_dropped_requests = 3;
        Specified by:
        getTotalDroppedRequests in interface ClusterStatsOrBuilder
        Returns:
        The totalDroppedRequests.
      • getDroppedRequestsList

        public java.util.List<ClusterStats.DroppedRequests> getDroppedRequestsList()
         Information about deliberately dropped requests for each category specified
         in the DropOverload policy.
         
        repeated .envoy.config.endpoint.v3.ClusterStats.DroppedRequests dropped_requests = 5;
        Specified by:
        getDroppedRequestsList in interface ClusterStatsOrBuilder
      • getDroppedRequestsCount

        public int getDroppedRequestsCount()
         Information about deliberately dropped requests for each category specified
         in the DropOverload policy.
         
        repeated .envoy.config.endpoint.v3.ClusterStats.DroppedRequests dropped_requests = 5;
        Specified by:
        getDroppedRequestsCount in interface ClusterStatsOrBuilder
      • getDroppedRequests

        public ClusterStats.DroppedRequests getDroppedRequests​(int index)
         Information about deliberately dropped requests for each category specified
         in the DropOverload policy.
         
        repeated .envoy.config.endpoint.v3.ClusterStats.DroppedRequests dropped_requests = 5;
        Specified by:
        getDroppedRequests in interface ClusterStatsOrBuilder
      • hasLoadReportInterval

        public boolean hasLoadReportInterval()
         Period over which the actual load report occurred. This will be guaranteed to include every
         request reported. Due to system load and delays between the ``LoadStatsRequest`` sent from Envoy
         and the ``LoadStatsResponse`` message sent from the management server, this may be longer than
         the requested load reporting interval in the ``LoadStatsResponse``.
         
        .google.protobuf.Duration load_report_interval = 4;
        Specified by:
        hasLoadReportInterval in interface ClusterStatsOrBuilder
        Returns:
        Whether the loadReportInterval field is set.
      • getLoadReportInterval

        public com.google.protobuf.Duration getLoadReportInterval()
         Period over which the actual load report occurred. This will be guaranteed to include every
         request reported. Due to system load and delays between the ``LoadStatsRequest`` sent from Envoy
         and the ``LoadStatsResponse`` message sent from the management server, this may be longer than
         the requested load reporting interval in the ``LoadStatsResponse``.
         
        .google.protobuf.Duration load_report_interval = 4;
        Specified by:
        getLoadReportInterval in interface ClusterStatsOrBuilder
        Returns:
        The loadReportInterval.
      • getLoadReportIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getLoadReportIntervalOrBuilder()
         Period over which the actual load report occurred. This will be guaranteed to include every
         request reported. Due to system load and delays between the ``LoadStatsRequest`` sent from Envoy
         and the ``LoadStatsResponse`` message sent from the management server, this may be longer than
         the requested load reporting interval in the ``LoadStatsResponse``.
         
        .google.protobuf.Duration load_report_interval = 4;
        Specified by:
        getLoadReportIntervalOrBuilder in interface ClusterStatsOrBuilder
      • isInitialized

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

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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 ClusterStats parseFrom​(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ClusterStats parseFrom​(java.nio.ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public static ClusterStats parseFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ClusterStats parseFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ClusterStats parseDelimitedFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ClusterStats parseDelimitedFrom​(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ClusterStats parseFrom​(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ClusterStats parseFrom​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected ClusterStats.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static ClusterStats getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<ClusterStats> parser()
      • getParserForType

        public com.google.protobuf.Parser<ClusterStats> 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.GeneratedMessage
      • getDefaultInstanceForType

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