Class UpstreamLocalityStats
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage
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: 12]Protobuf type
envoy.config.endpoint.v3.UpstreamLocalityStats
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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>`.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
private static final UpstreamLocalityStats
static final int
private List
<EndpointLoadMetricStats> private Locality
static final int
private byte
private static final com.google.protobuf.Parser
<UpstreamLocalityStats> private int
static final int
private static final long
static final int
static final int
static final int
static final int
static final int
static final int
static final int
private long
private long
private long
private long
private long
private long
private long
static final int
private List
<UpstreamEndpointStats> 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
UpstreamLocalityStats
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static UpstreamLocalityStats
static final com.google.protobuf.Descriptors.Descriptor
getLoadMetricStats
(int index) Stats for multi-dimensional load balancing.int
Stats for multi-dimensional load balancing.Stats for multi-dimensional load balancing.getLoadMetricStatsOrBuilder
(int index) Stats for multi-dimensional load balancing.List
<? extends EndpointLoadMetricStatsOrBuilder> Stats for multi-dimensional load balancing.Name of zone, region and optionally endpoint group these metrics were collected from.Name of zone, region and optionally endpoint group these metrics were collected from.com.google.protobuf.Parser
<UpstreamLocalityStats> int
[#not-implemented-hide:] The priority of the endpoint group these metrics were collected from.int
long
The total number of connections in an established state at the time of the report.long
The total number of requests that failed due to errors at the endpoint, aggregated over all endpoints in the locality.long
The total number of connection failures since the last report.long
The total number of requests that were issued by this Envoy since the last report.long
The total number of connections opened since the last report.long
The total number of unfinished requestslong
The total number of requests successfully completed by the endpoints in the locality.getUpstreamEndpointStats
(int index) Endpoint granularity stats information for this locality.int
Endpoint granularity stats information for this locality.Endpoint granularity stats information for this locality.getUpstreamEndpointStatsOrBuilder
(int index) Endpoint granularity stats information for this locality.List
<? extends UpstreamEndpointStatsOrBuilder> Endpoint granularity stats information for this locality.int
hashCode()
boolean
Name of zone, region and optionally endpoint group these metrics were collected from.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(UpstreamLocalityStats prototype) protected UpstreamLocalityStats.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static UpstreamLocalityStats
parseDelimitedFrom
(InputStream input) static UpstreamLocalityStats
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamLocalityStats
parseFrom
(byte[] data) static UpstreamLocalityStats
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamLocalityStats
parseFrom
(com.google.protobuf.ByteString data) static UpstreamLocalityStats
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamLocalityStats
parseFrom
(com.google.protobuf.CodedInputStream input) static UpstreamLocalityStats
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamLocalityStats
parseFrom
(InputStream input) static UpstreamLocalityStats
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamLocalityStats
parseFrom
(ByteBuffer data) static UpstreamLocalityStats
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<UpstreamLocalityStats> 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_ -
LOCALITY_FIELD_NUMBER
public static final int LOCALITY_FIELD_NUMBER- See Also:
-
locality_
-
TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER
public static final int TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER- See Also:
-
totalSuccessfulRequests_
private long totalSuccessfulRequests_ -
TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER
public static final int TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER- See Also:
-
totalRequestsInProgress_
private long totalRequestsInProgress_ -
TOTAL_ERROR_REQUESTS_FIELD_NUMBER
public static final int TOTAL_ERROR_REQUESTS_FIELD_NUMBER- See Also:
-
totalErrorRequests_
private long totalErrorRequests_ -
TOTAL_ISSUED_REQUESTS_FIELD_NUMBER
public static final int TOTAL_ISSUED_REQUESTS_FIELD_NUMBER- See Also:
-
totalIssuedRequests_
private long totalIssuedRequests_ -
TOTAL_ACTIVE_CONNECTIONS_FIELD_NUMBER
public static final int TOTAL_ACTIVE_CONNECTIONS_FIELD_NUMBER- See Also:
-
totalActiveConnections_
private long totalActiveConnections_ -
TOTAL_NEW_CONNECTIONS_FIELD_NUMBER
public static final int TOTAL_NEW_CONNECTIONS_FIELD_NUMBER- See Also:
-
totalNewConnections_
private long totalNewConnections_ -
TOTAL_FAIL_CONNECTIONS_FIELD_NUMBER
public static final int TOTAL_FAIL_CONNECTIONS_FIELD_NUMBER- See Also:
-
totalFailConnections_
private long totalFailConnections_ -
LOAD_METRIC_STATS_FIELD_NUMBER
public static final int LOAD_METRIC_STATS_FIELD_NUMBER- See Also:
-
loadMetricStats_
-
UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER
public static final int UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER- See Also:
-
upstreamEndpointStats_
-
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER- See Also:
-
priority_
private int priority_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
UpstreamLocalityStats
private UpstreamLocalityStats(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
UpstreamLocalityStats
private UpstreamLocalityStats()
-
-
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
-
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 interfaceUpstreamLocalityStatsOrBuilder
- Returns:
- Whether the locality field is set.
-
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 interfaceUpstreamLocalityStatsOrBuilder
- Returns:
- The locality.
-
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 interfaceUpstreamLocalityStatsOrBuilder
-
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 interfaceUpstreamLocalityStatsOrBuilder
- Returns:
- The totalSuccessfulRequests.
-
getTotalRequestsInProgress
public long getTotalRequestsInProgress()The total number of unfinished requests
uint64 total_requests_in_progress = 3;
- Specified by:
getTotalRequestsInProgress
in interfaceUpstreamLocalityStatsOrBuilder
- 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 interfaceUpstreamLocalityStatsOrBuilder
- 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.
uint64 total_issued_requests = 8;
- Specified by:
getTotalIssuedRequests
in interfaceUpstreamLocalityStatsOrBuilder
- 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 interfaceUpstreamLocalityStatsOrBuilder
- 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 interfaceUpstreamLocalityStatsOrBuilder
- 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 interfaceUpstreamLocalityStatsOrBuilder
- Returns:
- The totalFailConnections.
-
getLoadMetricStatsList
Stats for multi-dimensional load balancing.
repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
- Specified by:
getLoadMetricStatsList
in interfaceUpstreamLocalityStatsOrBuilder
-
getLoadMetricStatsOrBuilderList
Stats for multi-dimensional load balancing.
repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
- Specified by:
getLoadMetricStatsOrBuilderList
in interfaceUpstreamLocalityStatsOrBuilder
-
getLoadMetricStatsCount
public int getLoadMetricStatsCount()Stats for multi-dimensional load balancing.
repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
- Specified by:
getLoadMetricStatsCount
in interfaceUpstreamLocalityStatsOrBuilder
-
getLoadMetricStats
Stats for multi-dimensional load balancing.
repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
- Specified by:
getLoadMetricStats
in interfaceUpstreamLocalityStatsOrBuilder
-
getLoadMetricStatsOrBuilder
Stats for multi-dimensional load balancing.
repeated .envoy.config.endpoint.v3.EndpointLoadMetricStats load_metric_stats = 5;
- Specified by:
getLoadMetricStatsOrBuilder
in interfaceUpstreamLocalityStatsOrBuilder
-
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 interfaceUpstreamLocalityStatsOrBuilder
-
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 interfaceUpstreamLocalityStatsOrBuilder
-
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 interfaceUpstreamLocalityStatsOrBuilder
-
getUpstreamEndpointStats
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 interfaceUpstreamLocalityStatsOrBuilder
-
getUpstreamEndpointStatsOrBuilder
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 interfaceUpstreamLocalityStatsOrBuilder
-
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 interfaceUpstreamLocalityStatsOrBuilder
- Returns:
- The priority.
-
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 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
- Throws:
IOException
-
parseFrom
public static UpstreamLocalityStats parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- 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 UpstreamLocalityStats.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
-