Documentation ¶
Index ¶
- Variables
- type ClusterStats
- func (*ClusterStats) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterStats) GetClusterName() string
- func (x *ClusterStats) GetClusterServiceName() string
- func (x *ClusterStats) GetDroppedRequests() []*ClusterStats_DroppedRequests
- func (x *ClusterStats) GetLoadReportInterval() *durationpb.Duration
- func (x *ClusterStats) GetTotalDroppedRequests() uint64
- func (x *ClusterStats) GetUpstreamLocalityStats() []*UpstreamLocalityStats
- func (*ClusterStats) ProtoMessage()
- func (x *ClusterStats) ProtoReflect() protoreflect.Message
- func (x *ClusterStats) Reset()
- func (x *ClusterStats) String() string
- type ClusterStats_DroppedRequests
- func (*ClusterStats_DroppedRequests) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterStats_DroppedRequests) GetCategory() string
- func (x *ClusterStats_DroppedRequests) GetDroppedCount() uint64
- func (*ClusterStats_DroppedRequests) ProtoMessage()
- func (x *ClusterStats_DroppedRequests) ProtoReflect() protoreflect.Message
- func (x *ClusterStats_DroppedRequests) Reset()
- func (x *ClusterStats_DroppedRequests) String() string
- type Endpoint
- func (*Endpoint) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint) GetAddress() *core.Address
- func (x *Endpoint) GetHealthCheckConfig() *Endpoint_HealthCheckConfig
- func (x *Endpoint) GetHostname() string
- func (*Endpoint) ProtoMessage()
- func (x *Endpoint) ProtoReflect() protoreflect.Message
- func (x *Endpoint) Reset()
- func (x *Endpoint) String() string
- type EndpointLoadMetricStats
- func (*EndpointLoadMetricStats) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointLoadMetricStats) GetMetricName() string
- func (x *EndpointLoadMetricStats) GetNumRequestsFinishedWithMetric() uint64
- func (x *EndpointLoadMetricStats) GetTotalMetricValue() float64
- func (*EndpointLoadMetricStats) ProtoMessage()
- func (x *EndpointLoadMetricStats) ProtoReflect() protoreflect.Message
- func (x *EndpointLoadMetricStats) Reset()
- func (x *EndpointLoadMetricStats) String() string
- type Endpoint_HealthCheckConfig
- func (*Endpoint_HealthCheckConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint_HealthCheckConfig) GetHostname() string
- func (x *Endpoint_HealthCheckConfig) GetPortValue() uint32
- func (*Endpoint_HealthCheckConfig) ProtoMessage()
- func (x *Endpoint_HealthCheckConfig) ProtoReflect() protoreflect.Message
- func (x *Endpoint_HealthCheckConfig) Reset()
- func (x *Endpoint_HealthCheckConfig) String() string
- type LbEndpoint
- func (*LbEndpoint) Descriptor() ([]byte, []int)deprecated
- func (x *LbEndpoint) GetEndpoint() *Endpoint
- func (x *LbEndpoint) GetEndpointName() string
- func (x *LbEndpoint) GetHealthStatus() core.HealthStatus
- func (m *LbEndpoint) GetHostIdentifier() isLbEndpoint_HostIdentifier
- func (x *LbEndpoint) GetLoadBalancingWeight() *wrapperspb.UInt32Value
- func (x *LbEndpoint) GetMetadata() *core.Metadata
- func (*LbEndpoint) ProtoMessage()
- func (x *LbEndpoint) ProtoReflect() protoreflect.Message
- func (x *LbEndpoint) Reset()
- func (x *LbEndpoint) String() string
- type LbEndpoint_Endpoint
- type LbEndpoint_EndpointName
- type LocalityLbEndpoints
- func (*LocalityLbEndpoints) Descriptor() ([]byte, []int)deprecated
- func (x *LocalityLbEndpoints) GetLbEndpoints() []*LbEndpoint
- func (x *LocalityLbEndpoints) GetLoadBalancingWeight() *wrapperspb.UInt32Value
- func (x *LocalityLbEndpoints) GetLocality() *core.Locality
- func (x *LocalityLbEndpoints) GetPriority() uint32
- func (x *LocalityLbEndpoints) GetProximity() *wrapperspb.UInt32Value
- func (*LocalityLbEndpoints) ProtoMessage()
- func (x *LocalityLbEndpoints) ProtoReflect() protoreflect.Message
- func (x *LocalityLbEndpoints) Reset()
- func (x *LocalityLbEndpoints) String() string
- type UpstreamEndpointStats
- func (*UpstreamEndpointStats) Descriptor() ([]byte, []int)deprecated
- func (x *UpstreamEndpointStats) GetAddress() *core.Address
- func (x *UpstreamEndpointStats) GetLoadMetricStats() []*EndpointLoadMetricStats
- func (x *UpstreamEndpointStats) GetMetadata() *structpb.Struct
- func (x *UpstreamEndpointStats) GetTotalErrorRequests() uint64
- func (x *UpstreamEndpointStats) GetTotalIssuedRequests() uint64
- func (x *UpstreamEndpointStats) GetTotalRequestsInProgress() uint64
- func (x *UpstreamEndpointStats) GetTotalSuccessfulRequests() uint64
- func (*UpstreamEndpointStats) ProtoMessage()
- func (x *UpstreamEndpointStats) ProtoReflect() protoreflect.Message
- func (x *UpstreamEndpointStats) Reset()
- func (x *UpstreamEndpointStats) String() string
- type UpstreamLocalityStats
- func (*UpstreamLocalityStats) Descriptor() ([]byte, []int)deprecated
- func (x *UpstreamLocalityStats) GetLoadMetricStats() []*EndpointLoadMetricStats
- func (x *UpstreamLocalityStats) GetLocality() *core.Locality
- func (x *UpstreamLocalityStats) GetPriority() uint32
- func (x *UpstreamLocalityStats) GetTotalErrorRequests() uint64
- func (x *UpstreamLocalityStats) GetTotalIssuedRequests() uint64
- func (x *UpstreamLocalityStats) GetTotalRequestsInProgress() uint64
- func (x *UpstreamLocalityStats) GetTotalSuccessfulRequests() uint64
- func (x *UpstreamLocalityStats) GetUpstreamEndpointStats() []*UpstreamEndpointStats
- func (*UpstreamLocalityStats) ProtoMessage()
- func (x *UpstreamLocalityStats) ProtoReflect() protoreflect.Message
- func (x *UpstreamLocalityStats) Reset()
- func (x *UpstreamLocalityStats) String() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_api_v2_endpoint_endpoint_components_proto protoreflect.FileDescriptor
var File_envoy_api_v2_endpoint_endpoint_proto protoreflect.FileDescriptor
var File_envoy_api_v2_endpoint_load_report_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ClusterStats ¶
type ClusterStats struct { // The name of the cluster. ClusterName string `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"` // 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. ClusterServiceName string `protobuf:"bytes,6,opt,name=cluster_service_name,json=clusterServiceName,proto3" json:"cluster_service_name,omitempty"` // Need at least one. UpstreamLocalityStats []*UpstreamLocalityStats `` /* 126-byte string literal not displayed */ // 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. TotalDroppedRequests uint64 `protobuf:"varint,3,opt,name=total_dropped_requests,json=totalDroppedRequests,proto3" json:"total_dropped_requests,omitempty"` // Information about deliberately dropped requests for each category specified // in the DropOverload policy. DroppedRequests []*ClusterStats_DroppedRequests `protobuf:"bytes,5,rep,name=dropped_requests,json=droppedRequests,proto3" json:"dropped_requests,omitempty"` // 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*. LoadReportInterval *durationpb.Duration `protobuf:"bytes,4,opt,name=load_report_interval,json=loadReportInterval,proto3" json:"load_report_interval,omitempty"` // contains filtered or unexported fields }
Per cluster load stats. Envoy reports these stats a management server in a :ref:`LoadStatsRequest<envoy_api_msg_service.load_stats.v2.LoadStatsRequest>` [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs. Next ID: 7 [#next-free-field: 7]
func (*ClusterStats) Descriptor
deprecated
func (*ClusterStats) Descriptor() ([]byte, []int)
Deprecated: Use ClusterStats.ProtoReflect.Descriptor instead.
func (*ClusterStats) GetClusterName ¶
func (x *ClusterStats) GetClusterName() string
func (*ClusterStats) GetClusterServiceName ¶
func (x *ClusterStats) GetClusterServiceName() string
func (*ClusterStats) GetDroppedRequests ¶
func (x *ClusterStats) GetDroppedRequests() []*ClusterStats_DroppedRequests
func (*ClusterStats) GetLoadReportInterval ¶
func (x *ClusterStats) GetLoadReportInterval() *durationpb.Duration
func (*ClusterStats) GetTotalDroppedRequests ¶
func (x *ClusterStats) GetTotalDroppedRequests() uint64
func (*ClusterStats) GetUpstreamLocalityStats ¶
func (x *ClusterStats) GetUpstreamLocalityStats() []*UpstreamLocalityStats
func (*ClusterStats) ProtoMessage ¶
func (*ClusterStats) ProtoMessage()
func (*ClusterStats) ProtoReflect ¶
func (x *ClusterStats) ProtoReflect() protoreflect.Message
func (*ClusterStats) Reset ¶
func (x *ClusterStats) Reset()
func (*ClusterStats) String ¶
func (x *ClusterStats) String() string
type ClusterStats_DroppedRequests ¶
type ClusterStats_DroppedRequests struct { // Identifier for the policy specifying the drop. Category string `protobuf:"bytes,1,opt,name=category,proto3" json:"category,omitempty"` // Total number of deliberately dropped requests for the category. DroppedCount uint64 `protobuf:"varint,2,opt,name=dropped_count,json=droppedCount,proto3" json:"dropped_count,omitempty"` // contains filtered or unexported fields }
func (*ClusterStats_DroppedRequests) Descriptor
deprecated
func (*ClusterStats_DroppedRequests) Descriptor() ([]byte, []int)
Deprecated: Use ClusterStats_DroppedRequests.ProtoReflect.Descriptor instead.
func (*ClusterStats_DroppedRequests) GetCategory ¶
func (x *ClusterStats_DroppedRequests) GetCategory() string
func (*ClusterStats_DroppedRequests) GetDroppedCount ¶
func (x *ClusterStats_DroppedRequests) GetDroppedCount() uint64
func (*ClusterStats_DroppedRequests) ProtoMessage ¶
func (*ClusterStats_DroppedRequests) ProtoMessage()
func (*ClusterStats_DroppedRequests) ProtoReflect ¶
func (x *ClusterStats_DroppedRequests) ProtoReflect() protoreflect.Message
func (*ClusterStats_DroppedRequests) Reset ¶
func (x *ClusterStats_DroppedRequests) Reset()
func (*ClusterStats_DroppedRequests) String ¶
func (x *ClusterStats_DroppedRequests) String() string
type Endpoint ¶
type Endpoint struct { // The upstream host address. // // .. attention:: // // The form of host address depends on the given cluster type. For STATIC or EDS, // it is expected to be a direct IP address (or something resolvable by the // specified :ref:`resolver <envoy_api_field_core.SocketAddress.resolver_name>` // in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname, // and will be resolved via DNS. Address *core.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // The optional health check configuration is used as configuration for the // health checker to contact the health checked host. // // .. attention:: // // This takes into effect only for upstream clusters with // :ref:`active health checking <arch_overview_health_checking>` enabled. HealthCheckConfig *Endpoint_HealthCheckConfig `protobuf:"bytes,2,opt,name=health_check_config,json=healthCheckConfig,proto3" json:"health_check_config,omitempty"` // The hostname associated with this endpoint. This hostname is not used for routing or address // resolution. If provided, it will be associated with the endpoint, and can be used for features // that require a hostname, like // :ref:`auto_host_rewrite <envoy_api_field_route.RouteAction.auto_host_rewrite>`. Hostname string `protobuf:"bytes,3,opt,name=hostname,proto3" json:"hostname,omitempty"` // contains filtered or unexported fields }
Upstream host identifier.
func (*Endpoint) GetHealthCheckConfig ¶
func (x *Endpoint) GetHealthCheckConfig() *Endpoint_HealthCheckConfig
func (*Endpoint) ProtoReflect ¶
func (x *Endpoint) ProtoReflect() protoreflect.Message
type EndpointLoadMetricStats ¶
type EndpointLoadMetricStats struct { // Name of the metric; may be empty. MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"` // Number of calls that finished and included this metric. NumRequestsFinishedWithMetric uint64 `` /* 155-byte string literal not displayed */ // Sum of metric values across all calls that finished with this metric for // load_reporting_interval. TotalMetricValue float64 `protobuf:"fixed64,3,opt,name=total_metric_value,json=totalMetricValue,proto3" json:"total_metric_value,omitempty"` // contains filtered or unexported fields }
[#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.
func (*EndpointLoadMetricStats) Descriptor
deprecated
func (*EndpointLoadMetricStats) Descriptor() ([]byte, []int)
Deprecated: Use EndpointLoadMetricStats.ProtoReflect.Descriptor instead.
func (*EndpointLoadMetricStats) GetMetricName ¶
func (x *EndpointLoadMetricStats) GetMetricName() string
func (*EndpointLoadMetricStats) GetNumRequestsFinishedWithMetric ¶
func (x *EndpointLoadMetricStats) GetNumRequestsFinishedWithMetric() uint64
func (*EndpointLoadMetricStats) GetTotalMetricValue ¶
func (x *EndpointLoadMetricStats) GetTotalMetricValue() float64
func (*EndpointLoadMetricStats) ProtoMessage ¶
func (*EndpointLoadMetricStats) ProtoMessage()
func (*EndpointLoadMetricStats) ProtoReflect ¶
func (x *EndpointLoadMetricStats) ProtoReflect() protoreflect.Message
func (*EndpointLoadMetricStats) Reset ¶
func (x *EndpointLoadMetricStats) Reset()
func (*EndpointLoadMetricStats) String ¶
func (x *EndpointLoadMetricStats) String() string
type Endpoint_HealthCheckConfig ¶
type Endpoint_HealthCheckConfig struct { // Optional alternative health check port value. // // By default the health check address port of an upstream host is the same // as the host's serving address port. This provides an alternative health // check port. Setting this with a non-zero value allows an upstream host // to have different health check address port. PortValue uint32 `protobuf:"varint,1,opt,name=port_value,json=portValue,proto3" json:"port_value,omitempty"` // By default, the host header for L7 health checks is controlled by cluster level configuration // (see: :ref:`host <envoy_api_field_core.HealthCheck.HttpHealthCheck.host>` and // :ref:`authority <envoy_api_field_core.HealthCheck.GrpcHealthCheck.authority>`). Setting this // to a non-empty value allows overriding the cluster level configuration for a specific // endpoint. Hostname string `protobuf:"bytes,2,opt,name=hostname,proto3" json:"hostname,omitempty"` // contains filtered or unexported fields }
The optional health check configuration.
func (*Endpoint_HealthCheckConfig) Descriptor
deprecated
func (*Endpoint_HealthCheckConfig) Descriptor() ([]byte, []int)
Deprecated: Use Endpoint_HealthCheckConfig.ProtoReflect.Descriptor instead.
func (*Endpoint_HealthCheckConfig) GetHostname ¶
func (x *Endpoint_HealthCheckConfig) GetHostname() string
func (*Endpoint_HealthCheckConfig) GetPortValue ¶
func (x *Endpoint_HealthCheckConfig) GetPortValue() uint32
func (*Endpoint_HealthCheckConfig) ProtoMessage ¶
func (*Endpoint_HealthCheckConfig) ProtoMessage()
func (*Endpoint_HealthCheckConfig) ProtoReflect ¶
func (x *Endpoint_HealthCheckConfig) ProtoReflect() protoreflect.Message
func (*Endpoint_HealthCheckConfig) Reset ¶
func (x *Endpoint_HealthCheckConfig) Reset()
func (*Endpoint_HealthCheckConfig) String ¶
func (x *Endpoint_HealthCheckConfig) String() string
type LbEndpoint ¶
type LbEndpoint struct { // Upstream host identifier or a named reference. // // Types that are assignable to HostIdentifier: // // *LbEndpoint_Endpoint // *LbEndpoint_EndpointName HostIdentifier isLbEndpoint_HostIdentifier `protobuf_oneof:"host_identifier"` // Optional health status when known and supplied by EDS server. HealthStatus core.HealthStatus `` /* 134-byte string literal not displayed */ // The endpoint metadata specifies values that may be used by the load // balancer to select endpoints in a cluster for a given request. The filter // name should be specified as *envoy.lb*. An example boolean key-value pair // is *canary*, providing the optional canary status of the upstream host. // This may be matched against in a route's // :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field // to subset the endpoints considered in cluster load balancing. Metadata *core.Metadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"` // The optional load balancing weight of the upstream host; at least 1. // Envoy uses the load balancing weight in some of the built in load // balancers. The load balancing weight for an endpoint is divided by the sum // of the weights of all endpoints in the endpoint's locality to produce a // percentage of traffic for the endpoint. This percentage is then further // weighted by the endpoint's locality's load balancing weight from // LocalityLbEndpoints. If unspecified, each host is presumed to have equal // weight in a locality. The sum of the weights of all endpoints in the // endpoint's locality must not exceed uint32_t maximal value (4294967295). LoadBalancingWeight *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=load_balancing_weight,json=loadBalancingWeight,proto3" json:"load_balancing_weight,omitempty"` // contains filtered or unexported fields }
An Endpoint that Envoy can route traffic to. [#next-free-field: 6]
func (*LbEndpoint) Descriptor
deprecated
func (*LbEndpoint) Descriptor() ([]byte, []int)
Deprecated: Use LbEndpoint.ProtoReflect.Descriptor instead.
func (*LbEndpoint) GetEndpoint ¶
func (x *LbEndpoint) GetEndpoint() *Endpoint
func (*LbEndpoint) GetEndpointName ¶
func (x *LbEndpoint) GetEndpointName() string
func (*LbEndpoint) GetHealthStatus ¶
func (x *LbEndpoint) GetHealthStatus() core.HealthStatus
func (*LbEndpoint) GetHostIdentifier ¶
func (m *LbEndpoint) GetHostIdentifier() isLbEndpoint_HostIdentifier
func (*LbEndpoint) GetLoadBalancingWeight ¶
func (x *LbEndpoint) GetLoadBalancingWeight() *wrapperspb.UInt32Value
func (*LbEndpoint) GetMetadata ¶
func (x *LbEndpoint) GetMetadata() *core.Metadata
func (*LbEndpoint) ProtoMessage ¶
func (*LbEndpoint) ProtoMessage()
func (*LbEndpoint) ProtoReflect ¶
func (x *LbEndpoint) ProtoReflect() protoreflect.Message
func (*LbEndpoint) Reset ¶
func (x *LbEndpoint) Reset()
func (*LbEndpoint) String ¶
func (x *LbEndpoint) String() string
type LbEndpoint_Endpoint ¶
type LbEndpoint_Endpoint struct {
Endpoint *Endpoint `protobuf:"bytes,1,opt,name=endpoint,proto3,oneof"`
}
type LbEndpoint_EndpointName ¶
type LbEndpoint_EndpointName struct { // [#not-implemented-hide:] EndpointName string `protobuf:"bytes,5,opt,name=endpoint_name,json=endpointName,proto3,oneof"` }
type LocalityLbEndpoints ¶
type LocalityLbEndpoints struct { // Identifies location of where the upstream hosts run. Locality *core.Locality `protobuf:"bytes,1,opt,name=locality,proto3" json:"locality,omitempty"` // The group of endpoints belonging to the locality specified. LbEndpoints []*LbEndpoint `protobuf:"bytes,2,rep,name=lb_endpoints,json=lbEndpoints,proto3" json:"lb_endpoints,omitempty"` // Optional: Per priority/region/zone/sub_zone weight; at least 1. The load // balancing weight for a locality is divided by the sum of the weights of all // localities at the same priority level to produce the effective percentage // of traffic for the locality. The sum of the weights of all localities at // the same priority level must not exceed uint32_t maximal value (4294967295). // // Locality weights are only considered when :ref:`locality weighted load // balancing <arch_overview_load_balancing_locality_weighted_lb>` is // configured. These weights are ignored otherwise. If no weights are // specified when locality weighted load balancing is enabled, the locality is // assigned no load. LoadBalancingWeight *wrapperspb.UInt32Value `protobuf:"bytes,3,opt,name=load_balancing_weight,json=loadBalancingWeight,proto3" json:"load_balancing_weight,omitempty"` // Optional: the priority for this LocalityLbEndpoints. If unspecified this will // default to the highest priority (0). // // Under usual circumstances, Envoy will only select endpoints for the highest // priority (0). In the event all endpoints for a particular priority are // unavailable/unhealthy, Envoy will fail over to selecting endpoints for the // next highest priority group. // // Priorities should range from 0 (highest) to N (lowest) without skipping. Priority uint32 `protobuf:"varint,5,opt,name=priority,proto3" json:"priority,omitempty"` // Optional: Per locality proximity value which indicates how close this // locality is from the source locality. This value only provides ordering // information (lower the value, closer it is to the source locality). // This will be consumed by load balancing schemes that need proximity order // to determine where to route the requests. // [#not-implemented-hide:] Proximity *wrapperspb.UInt32Value `protobuf:"bytes,6,opt,name=proximity,proto3" json:"proximity,omitempty"` // contains filtered or unexported fields }
A group of endpoints belonging to a Locality. One can have multiple LocalityLbEndpoints for a locality, but this is generally only done if the different groups need to have different load balancing weights or different priorities. [#next-free-field: 7]
func (*LocalityLbEndpoints) Descriptor
deprecated
func (*LocalityLbEndpoints) Descriptor() ([]byte, []int)
Deprecated: Use LocalityLbEndpoints.ProtoReflect.Descriptor instead.
func (*LocalityLbEndpoints) GetLbEndpoints ¶
func (x *LocalityLbEndpoints) GetLbEndpoints() []*LbEndpoint
func (*LocalityLbEndpoints) GetLoadBalancingWeight ¶
func (x *LocalityLbEndpoints) GetLoadBalancingWeight() *wrapperspb.UInt32Value
func (*LocalityLbEndpoints) GetLocality ¶
func (x *LocalityLbEndpoints) GetLocality() *core.Locality
func (*LocalityLbEndpoints) GetPriority ¶
func (x *LocalityLbEndpoints) GetPriority() uint32
func (*LocalityLbEndpoints) GetProximity ¶
func (x *LocalityLbEndpoints) GetProximity() *wrapperspb.UInt32Value
func (*LocalityLbEndpoints) ProtoMessage ¶
func (*LocalityLbEndpoints) ProtoMessage()
func (*LocalityLbEndpoints) ProtoReflect ¶
func (x *LocalityLbEndpoints) ProtoReflect() protoreflect.Message
func (*LocalityLbEndpoints) Reset ¶
func (x *LocalityLbEndpoints) Reset()
func (*LocalityLbEndpoints) String ¶
func (x *LocalityLbEndpoints) String() string
type UpstreamEndpointStats ¶
type UpstreamEndpointStats struct { // Upstream host address. Address *core.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // Opaque and implementation dependent metadata of the // endpoint. Envoy will pass this directly to the management server. Metadata *structpb.Struct `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"` // The total number of requests successfully completed by the endpoints in the // locality. These include non-5xx responses for HTTP, where errors // originate at the client and the endpoint responded successfully. For gRPC, // the grpc-status values are those not covered by total_error_requests below. TotalSuccessfulRequests uint64 `` /* 133-byte string literal not displayed */ // The total number of unfinished requests for this endpoint. TotalRequestsInProgress uint64 `` /* 135-byte string literal not displayed */ // The total number of requests that failed due to errors at the endpoint. // For HTTP these are responses with 5xx status codes and for gRPC the // grpc-status values: // // - DeadlineExceeded // - Unimplemented // - Internal // - Unavailable // - Unknown // - DataLoss TotalErrorRequests uint64 `protobuf:"varint,4,opt,name=total_error_requests,json=totalErrorRequests,proto3" json:"total_error_requests,omitempty"` // The total number of requests that were issued to this endpoint // since the last report. A single TCP connection, HTTP or gRPC // request or stream is counted as one request. TotalIssuedRequests uint64 `protobuf:"varint,7,opt,name=total_issued_requests,json=totalIssuedRequests,proto3" json:"total_issued_requests,omitempty"` // Stats for multi-dimensional load balancing. LoadMetricStats []*EndpointLoadMetricStats `protobuf:"bytes,5,rep,name=load_metric_stats,json=loadMetricStats,proto3" json:"load_metric_stats,omitempty"` // contains filtered or unexported fields }
[#not-implemented-hide:] Not configuration. TBD how to doc proto APIs. [#next-free-field: 8]
func (*UpstreamEndpointStats) Descriptor
deprecated
func (*UpstreamEndpointStats) Descriptor() ([]byte, []int)
Deprecated: Use UpstreamEndpointStats.ProtoReflect.Descriptor instead.
func (*UpstreamEndpointStats) GetAddress ¶
func (x *UpstreamEndpointStats) GetAddress() *core.Address
func (*UpstreamEndpointStats) GetLoadMetricStats ¶
func (x *UpstreamEndpointStats) GetLoadMetricStats() []*EndpointLoadMetricStats
func (*UpstreamEndpointStats) GetMetadata ¶
func (x *UpstreamEndpointStats) GetMetadata() *structpb.Struct
func (*UpstreamEndpointStats) GetTotalErrorRequests ¶
func (x *UpstreamEndpointStats) GetTotalErrorRequests() uint64
func (*UpstreamEndpointStats) GetTotalIssuedRequests ¶
func (x *UpstreamEndpointStats) GetTotalIssuedRequests() uint64
func (*UpstreamEndpointStats) GetTotalRequestsInProgress ¶
func (x *UpstreamEndpointStats) GetTotalRequestsInProgress() uint64
func (*UpstreamEndpointStats) GetTotalSuccessfulRequests ¶
func (x *UpstreamEndpointStats) GetTotalSuccessfulRequests() uint64
func (*UpstreamEndpointStats) ProtoMessage ¶
func (*UpstreamEndpointStats) ProtoMessage()
func (*UpstreamEndpointStats) ProtoReflect ¶
func (x *UpstreamEndpointStats) ProtoReflect() protoreflect.Message
func (*UpstreamEndpointStats) Reset ¶
func (x *UpstreamEndpointStats) Reset()
func (*UpstreamEndpointStats) String ¶
func (x *UpstreamEndpointStats) String() string
type UpstreamLocalityStats ¶
type UpstreamLocalityStats struct { // Name of zone, region and optionally endpoint group these metrics were // collected from. Zone and region names could be empty if unknown. Locality *core.Locality `protobuf:"bytes,1,opt,name=locality,proto3" json:"locality,omitempty"` // The total number of requests successfully completed by the endpoints in the // locality. TotalSuccessfulRequests uint64 `` /* 133-byte string literal not displayed */ // The total number of unfinished requests TotalRequestsInProgress uint64 `` /* 135-byte string literal not displayed */ // The total number of requests that failed due to errors at the endpoint, // aggregated over all endpoints in the locality. TotalErrorRequests uint64 `protobuf:"varint,4,opt,name=total_error_requests,json=totalErrorRequests,proto3" json:"total_error_requests,omitempty"` // 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. TotalIssuedRequests uint64 `protobuf:"varint,8,opt,name=total_issued_requests,json=totalIssuedRequests,proto3" json:"total_issued_requests,omitempty"` // Stats for multi-dimensional load balancing. LoadMetricStats []*EndpointLoadMetricStats `protobuf:"bytes,5,rep,name=load_metric_stats,json=loadMetricStats,proto3" json:"load_metric_stats,omitempty"` // Endpoint granularity stats information for this locality. This information // is populated if the Server requests it by setting // :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`. UpstreamEndpointStats []*UpstreamEndpointStats `` /* 126-byte string literal not displayed */ // [#not-implemented-hide:] The priority of the endpoint group these metrics // were collected from. Priority uint32 `protobuf:"varint,6,opt,name=priority,proto3" json:"priority,omitempty"` // contains filtered or unexported fields }
These are stats Envoy reports to GLB every so often. Report frequency is defined by :ref:`LoadStatsResponse.load_reporting_interval<envoy_api_field_service.load_stats.v2.LoadStatsResponse.load_reporting_interval>`. Stats per upstream region/zone and optionally per subzone. [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs. [#next-free-field: 9]
func (*UpstreamLocalityStats) Descriptor
deprecated
func (*UpstreamLocalityStats) Descriptor() ([]byte, []int)
Deprecated: Use UpstreamLocalityStats.ProtoReflect.Descriptor instead.
func (*UpstreamLocalityStats) GetLoadMetricStats ¶
func (x *UpstreamLocalityStats) GetLoadMetricStats() []*EndpointLoadMetricStats
func (*UpstreamLocalityStats) GetLocality ¶
func (x *UpstreamLocalityStats) GetLocality() *core.Locality
func (*UpstreamLocalityStats) GetPriority ¶
func (x *UpstreamLocalityStats) GetPriority() uint32
func (*UpstreamLocalityStats) GetTotalErrorRequests ¶
func (x *UpstreamLocalityStats) GetTotalErrorRequests() uint64
func (*UpstreamLocalityStats) GetTotalIssuedRequests ¶
func (x *UpstreamLocalityStats) GetTotalIssuedRequests() uint64
func (*UpstreamLocalityStats) GetTotalRequestsInProgress ¶
func (x *UpstreamLocalityStats) GetTotalRequestsInProgress() uint64
func (*UpstreamLocalityStats) GetTotalSuccessfulRequests ¶
func (x *UpstreamLocalityStats) GetTotalSuccessfulRequests() uint64
func (*UpstreamLocalityStats) GetUpstreamEndpointStats ¶
func (x *UpstreamLocalityStats) GetUpstreamEndpointStats() []*UpstreamEndpointStats
func (*UpstreamLocalityStats) ProtoMessage ¶
func (*UpstreamLocalityStats) ProtoMessage()
func (*UpstreamLocalityStats) ProtoReflect ¶
func (x *UpstreamLocalityStats) ProtoReflect() protoreflect.Message
func (*UpstreamLocalityStats) Reset ¶
func (x *UpstreamLocalityStats) Reset()
func (*UpstreamLocalityStats) String ¶
func (x *UpstreamLocalityStats) String() string