Class ClusterStats
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.endpoint.v3.ClusterStats
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ClusterStatsOrBuilder
,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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Per cluster load stats.static final class
Protobuf typeenvoy.config.endpoint.v3.ClusterStats.DroppedRequests
static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
static final int
static final int
private Object
private Object
private static final ClusterStats
static final int
private List
<ClusterStats.DroppedRequests> static final int
private com.google.protobuf.Duration
private byte
private static final com.google.protobuf.Parser
<ClusterStats> private static final long
static final int
private long
static final int
private List
<UpstreamLocalityStats> Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ClusterStats
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
The name of the cluster.com.google.protobuf.ByteString
The name of the cluster.The eds_cluster_config service_name of the cluster.com.google.protobuf.ByteString
The eds_cluster_config service_name of the cluster.static ClusterStats
static final com.google.protobuf.Descriptors.Descriptor
getDroppedRequests
(int index) Information about deliberately dropped requests for each category specified in the DropOverload policy.int
Information about deliberately dropped requests for each category specified in the DropOverload policy.Information about deliberately dropped requests for each category specified in the DropOverload policy.getDroppedRequestsOrBuilder
(int index) Information about deliberately dropped requests for each category specified in the DropOverload policy.List
<? extends ClusterStats.DroppedRequestsOrBuilder> Information about deliberately dropped requests for each category specified in the DropOverload policy.com.google.protobuf.Duration
Period over which the actual load report occurred.com.google.protobuf.DurationOrBuilder
Period over which the actual load report occurred.com.google.protobuf.Parser
<ClusterStats> int
long
Cluster-level stats such as total_successful_requests may be computed by summing upstream_locality_stats.getUpstreamLocalityStats
(int index) Need at least one.int
Need at least one.Need at least one.getUpstreamLocalityStatsOrBuilder
(int index) Need at least one.List
<? extends UpstreamLocalityStatsOrBuilder> Need at least one.int
hashCode()
boolean
Period over which the actual load report occurred.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static ClusterStats.Builder
static ClusterStats.Builder
newBuilder
(ClusterStats prototype) protected ClusterStats.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static ClusterStats
parseDelimitedFrom
(InputStream input) static ClusterStats
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterStats
parseFrom
(byte[] data) static ClusterStats
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterStats
parseFrom
(com.google.protobuf.ByteString data) static ClusterStats
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterStats
parseFrom
(com.google.protobuf.CodedInputStream input) static ClusterStats
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterStats
parseFrom
(InputStream input) static ClusterStats
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterStats
parseFrom
(ByteBuffer data) static ClusterStats
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ClusterStats> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER- See Also:
-
clusterName_
-
CLUSTER_SERVICE_NAME_FIELD_NUMBER
public static final int CLUSTER_SERVICE_NAME_FIELD_NUMBER- See Also:
-
clusterServiceName_
-
UPSTREAM_LOCALITY_STATS_FIELD_NUMBER
public static final int UPSTREAM_LOCALITY_STATS_FIELD_NUMBER- See Also:
-
upstreamLocalityStats_
-
TOTAL_DROPPED_REQUESTS_FIELD_NUMBER
public static final int TOTAL_DROPPED_REQUESTS_FIELD_NUMBER- See Also:
-
totalDroppedRequests_
private long totalDroppedRequests_ -
DROPPED_REQUESTS_FIELD_NUMBER
public static final int DROPPED_REQUESTS_FIELD_NUMBER- See Also:
-
droppedRequests_
-
LOAD_REPORT_INTERVAL_FIELD_NUMBER
public static final int LOAD_REPORT_INTERVAL_FIELD_NUMBER- See Also:
-
loadReportInterval_
private com.google.protobuf.Duration loadReportInterval_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ClusterStats
private ClusterStats(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ClusterStats
private ClusterStats()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getClusterName
The name of the cluster.
string cluster_name = 1 [(.validate.rules) = { ... }
- Specified by:
getClusterName
in interfaceClusterStatsOrBuilder
- 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 interfaceClusterStatsOrBuilder
- Returns:
- The bytes for clusterName.
-
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 interfaceClusterStatsOrBuilder
- 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 interfaceClusterStatsOrBuilder
- Returns:
- The bytes for clusterServiceName.
-
getUpstreamLocalityStatsList
Need at least one.
repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
- Specified by:
getUpstreamLocalityStatsList
in interfaceClusterStatsOrBuilder
-
getUpstreamLocalityStatsOrBuilderList
Need at least one.
repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
- Specified by:
getUpstreamLocalityStatsOrBuilderList
in interfaceClusterStatsOrBuilder
-
getUpstreamLocalityStatsCount
public int getUpstreamLocalityStatsCount()Need at least one.
repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
- Specified by:
getUpstreamLocalityStatsCount
in interfaceClusterStatsOrBuilder
-
getUpstreamLocalityStats
Need at least one.
repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
- Specified by:
getUpstreamLocalityStats
in interfaceClusterStatsOrBuilder
-
getUpstreamLocalityStatsOrBuilder
Need at least one.
repeated .envoy.config.endpoint.v3.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }
- Specified by:
getUpstreamLocalityStatsOrBuilder
in interfaceClusterStatsOrBuilder
-
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 interfaceClusterStatsOrBuilder
- Returns:
- The totalDroppedRequests.
-
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 interfaceClusterStatsOrBuilder
-
getDroppedRequestsOrBuilderList
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:
getDroppedRequestsOrBuilderList
in interfaceClusterStatsOrBuilder
-
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 interfaceClusterStatsOrBuilder
-
getDroppedRequests
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 interfaceClusterStatsOrBuilder
-
getDroppedRequestsOrBuilder
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:
getDroppedRequestsOrBuilder
in interfaceClusterStatsOrBuilder
-
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 interfaceClusterStatsOrBuilder
- 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 interfaceClusterStatsOrBuilder
- 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 interfaceClusterStatsOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ClusterStats parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterStats parseFrom(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
- Throws:
IOException
-
parseFrom
public static ClusterStats parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ClusterStats parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ClusterStats parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ClusterStats.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-