endpoint

package
v0.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2018 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthEndpoint = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowEndpoint   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthLoadReport = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowLoadReport   = fmt.Errorf("proto: integer overflow")
)

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"`
	// Need at least one.
	UpstreamLocalityStats []*UpstreamLocalityStats `protobuf:"bytes,2,rep,name=upstream_locality_stats,json=upstreamLocalityStats" json:"upstream_locality_stats,omitempty"`
	// 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 following total_requests equality holds at the
	// cluster-level:
	//
	// .. code-block:: none
	//
	//   sum_locality(total_successful_requests) + sum_locality(total_requests_in_progress) +
	//     sum_locality(total_error_requests) + total_dropped_requests`
	//
	// 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" 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   *types.Duration `protobuf:"bytes,4,opt,name=load_report_interval,json=loadReportInterval" json:"load_report_interval,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Per cluster load stats. Envoy reports these stats a management server in a :ref:`LoadStatsRequest<envoy_api_msg_load_stats.LoadStatsRequest>` [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.

func (*ClusterStats) Descriptor

func (*ClusterStats) Descriptor() ([]byte, []int)

func (*ClusterStats) GetClusterName

func (m *ClusterStats) GetClusterName() string

func (*ClusterStats) GetDroppedRequests

func (m *ClusterStats) GetDroppedRequests() []*ClusterStats_DroppedRequests

func (*ClusterStats) GetLoadReportInterval

func (m *ClusterStats) GetLoadReportInterval() *types.Duration

func (*ClusterStats) GetTotalDroppedRequests

func (m *ClusterStats) GetTotalDroppedRequests() uint64

func (*ClusterStats) GetUpstreamLocalityStats

func (m *ClusterStats) GetUpstreamLocalityStats() []*UpstreamLocalityStats

func (*ClusterStats) Marshal added in v0.5.0

func (m *ClusterStats) Marshal() (dAtA []byte, err error)

func (*ClusterStats) MarshalTo added in v0.5.0

func (m *ClusterStats) MarshalTo(dAtA []byte) (int, error)

func (*ClusterStats) ProtoMessage

func (*ClusterStats) ProtoMessage()

func (*ClusterStats) Reset

func (m *ClusterStats) Reset()

func (*ClusterStats) Size added in v0.5.0

func (m *ClusterStats) Size() (n int)

func (*ClusterStats) String

func (m *ClusterStats) String() string

func (*ClusterStats) Unmarshal added in v0.5.0

func (m *ClusterStats) Unmarshal(dAtA []byte) error

func (*ClusterStats) Validate

func (m *ClusterStats) Validate() error

Validate checks the field values on ClusterStats with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*ClusterStats) XXX_DiscardUnknown added in v0.5.0

func (m *ClusterStats) XXX_DiscardUnknown()

func (*ClusterStats) XXX_Marshal added in v0.5.0

func (m *ClusterStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClusterStats) XXX_Merge added in v0.5.0

func (dst *ClusterStats) XXX_Merge(src proto.Message)

func (*ClusterStats) XXX_Size added in v0.5.0

func (m *ClusterStats) XXX_Size() int

func (*ClusterStats) XXX_Unmarshal added in v0.5.0

func (m *ClusterStats) XXX_Unmarshal(b []byte) error

type ClusterStatsValidationError

type ClusterStatsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

ClusterStatsValidationError is the validation error returned by ClusterStats.Validate if the designated constraints aren't met.

func (ClusterStatsValidationError) Error

Error satisfies the builtin error interface

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ClusterStats_DroppedRequests) Descriptor

func (*ClusterStats_DroppedRequests) Descriptor() ([]byte, []int)

func (*ClusterStats_DroppedRequests) GetCategory

func (m *ClusterStats_DroppedRequests) GetCategory() string

func (*ClusterStats_DroppedRequests) GetDroppedCount

func (m *ClusterStats_DroppedRequests) GetDroppedCount() uint64

func (*ClusterStats_DroppedRequests) Marshal added in v0.5.0

func (m *ClusterStats_DroppedRequests) Marshal() (dAtA []byte, err error)

func (*ClusterStats_DroppedRequests) MarshalTo added in v0.5.0

func (m *ClusterStats_DroppedRequests) MarshalTo(dAtA []byte) (int, error)

func (*ClusterStats_DroppedRequests) ProtoMessage

func (*ClusterStats_DroppedRequests) ProtoMessage()

func (*ClusterStats_DroppedRequests) Reset

func (m *ClusterStats_DroppedRequests) Reset()

func (*ClusterStats_DroppedRequests) Size added in v0.5.0

func (m *ClusterStats_DroppedRequests) Size() (n int)

func (*ClusterStats_DroppedRequests) String

func (*ClusterStats_DroppedRequests) Unmarshal added in v0.5.0

func (m *ClusterStats_DroppedRequests) Unmarshal(dAtA []byte) error

func (*ClusterStats_DroppedRequests) Validate

func (m *ClusterStats_DroppedRequests) Validate() error

Validate checks the field values on ClusterStats_DroppedRequests with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*ClusterStats_DroppedRequests) XXX_DiscardUnknown added in v0.5.0

func (m *ClusterStats_DroppedRequests) XXX_DiscardUnknown()

func (*ClusterStats_DroppedRequests) XXX_Marshal added in v0.5.0

func (m *ClusterStats_DroppedRequests) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClusterStats_DroppedRequests) XXX_Merge added in v0.5.0

func (dst *ClusterStats_DroppedRequests) XXX_Merge(src proto.Message)

func (*ClusterStats_DroppedRequests) XXX_Size added in v0.5.0

func (m *ClusterStats_DroppedRequests) XXX_Size() int

func (*ClusterStats_DroppedRequests) XXX_Unmarshal added in v0.5.0

func (m *ClusterStats_DroppedRequests) XXX_Unmarshal(b []byte) error

type ClusterStats_DroppedRequestsValidationError

type ClusterStats_DroppedRequestsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

ClusterStats_DroppedRequestsValidationError is the validation error returned by ClusterStats_DroppedRequests.Validate if the designated constraints aren't met.

func (ClusterStats_DroppedRequestsValidationError) Error

Error satisfies the builtin error interface

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" 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" json:"health_check_config,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

Upstream host identifier.

func (*Endpoint) Descriptor

func (*Endpoint) Descriptor() ([]byte, []int)

func (*Endpoint) Equal added in v0.5.0

func (this *Endpoint) Equal(that interface{}) bool

func (*Endpoint) GetAddress

func (m *Endpoint) GetAddress() *core.Address

func (*Endpoint) GetHealthCheckConfig

func (m *Endpoint) GetHealthCheckConfig() *Endpoint_HealthCheckConfig

func (*Endpoint) Marshal added in v0.5.0

func (m *Endpoint) Marshal() (dAtA []byte, err error)

func (*Endpoint) MarshalTo added in v0.5.0

func (m *Endpoint) MarshalTo(dAtA []byte) (int, error)

func (*Endpoint) ProtoMessage

func (*Endpoint) ProtoMessage()

func (*Endpoint) Reset

func (m *Endpoint) Reset()

func (*Endpoint) Size added in v0.5.0

func (m *Endpoint) Size() (n int)

func (*Endpoint) String

func (m *Endpoint) String() string

func (*Endpoint) Unmarshal added in v0.5.0

func (m *Endpoint) Unmarshal(dAtA []byte) error

func (*Endpoint) Validate

func (m *Endpoint) Validate() error

Validate checks the field values on Endpoint with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*Endpoint) XXX_DiscardUnknown added in v0.5.0

func (m *Endpoint) XXX_DiscardUnknown()

func (*Endpoint) XXX_Marshal added in v0.5.0

func (m *Endpoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Endpoint) XXX_Merge added in v0.5.0

func (dst *Endpoint) XXX_Merge(src proto.Message)

func (*Endpoint) XXX_Size added in v0.5.0

func (m *Endpoint) XXX_Size() int

func (*Endpoint) XXX_Unmarshal added in v0.5.0

func (m *Endpoint) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

[#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.

func (*EndpointLoadMetricStats) Descriptor

func (*EndpointLoadMetricStats) Descriptor() ([]byte, []int)

func (*EndpointLoadMetricStats) GetMetricName

func (m *EndpointLoadMetricStats) GetMetricName() string

func (*EndpointLoadMetricStats) GetNumRequestsFinishedWithMetric

func (m *EndpointLoadMetricStats) GetNumRequestsFinishedWithMetric() uint64

func (*EndpointLoadMetricStats) GetTotalMetricValue

func (m *EndpointLoadMetricStats) GetTotalMetricValue() float64

func (*EndpointLoadMetricStats) Marshal added in v0.5.0

func (m *EndpointLoadMetricStats) Marshal() (dAtA []byte, err error)

func (*EndpointLoadMetricStats) MarshalTo added in v0.5.0

func (m *EndpointLoadMetricStats) MarshalTo(dAtA []byte) (int, error)

func (*EndpointLoadMetricStats) ProtoMessage

func (*EndpointLoadMetricStats) ProtoMessage()

func (*EndpointLoadMetricStats) Reset

func (m *EndpointLoadMetricStats) Reset()

func (*EndpointLoadMetricStats) Size added in v0.5.0

func (m *EndpointLoadMetricStats) Size() (n int)

func (*EndpointLoadMetricStats) String

func (m *EndpointLoadMetricStats) String() string

func (*EndpointLoadMetricStats) Unmarshal added in v0.5.0

func (m *EndpointLoadMetricStats) Unmarshal(dAtA []byte) error

func (*EndpointLoadMetricStats) Validate

func (m *EndpointLoadMetricStats) Validate() error

Validate checks the field values on EndpointLoadMetricStats with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*EndpointLoadMetricStats) XXX_DiscardUnknown added in v0.5.0

func (m *EndpointLoadMetricStats) XXX_DiscardUnknown()

func (*EndpointLoadMetricStats) XXX_Marshal added in v0.5.0

func (m *EndpointLoadMetricStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EndpointLoadMetricStats) XXX_Merge added in v0.5.0

func (dst *EndpointLoadMetricStats) XXX_Merge(src proto.Message)

func (*EndpointLoadMetricStats) XXX_Size added in v0.5.0

func (m *EndpointLoadMetricStats) XXX_Size() int

func (*EndpointLoadMetricStats) XXX_Unmarshal added in v0.5.0

func (m *EndpointLoadMetricStats) XXX_Unmarshal(b []byte) error

type EndpointLoadMetricStatsValidationError

type EndpointLoadMetricStatsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

EndpointLoadMetricStatsValidationError is the validation error returned by EndpointLoadMetricStats.Validate if the designated constraints aren't met.

func (EndpointLoadMetricStatsValidationError) Error

Error satisfies the builtin error interface

type EndpointValidationError

type EndpointValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

EndpointValidationError is the validation error returned by Endpoint.Validate if the designated constraints aren't met.

func (EndpointValidationError) Error

func (e EndpointValidationError) Error() string

Error satisfies the builtin error interface

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The optional health check configuration.

func (*Endpoint_HealthCheckConfig) Descriptor

func (*Endpoint_HealthCheckConfig) Descriptor() ([]byte, []int)

func (*Endpoint_HealthCheckConfig) Equal added in v0.5.0

func (this *Endpoint_HealthCheckConfig) Equal(that interface{}) bool

func (*Endpoint_HealthCheckConfig) GetPortValue

func (m *Endpoint_HealthCheckConfig) GetPortValue() uint32

func (*Endpoint_HealthCheckConfig) Marshal added in v0.5.0

func (m *Endpoint_HealthCheckConfig) Marshal() (dAtA []byte, err error)

func (*Endpoint_HealthCheckConfig) MarshalTo added in v0.5.0

func (m *Endpoint_HealthCheckConfig) MarshalTo(dAtA []byte) (int, error)

func (*Endpoint_HealthCheckConfig) ProtoMessage

func (*Endpoint_HealthCheckConfig) ProtoMessage()

func (*Endpoint_HealthCheckConfig) Reset

func (m *Endpoint_HealthCheckConfig) Reset()

func (*Endpoint_HealthCheckConfig) Size added in v0.5.0

func (m *Endpoint_HealthCheckConfig) Size() (n int)

func (*Endpoint_HealthCheckConfig) String

func (m *Endpoint_HealthCheckConfig) String() string

func (*Endpoint_HealthCheckConfig) Unmarshal added in v0.5.0

func (m *Endpoint_HealthCheckConfig) Unmarshal(dAtA []byte) error

func (*Endpoint_HealthCheckConfig) Validate

func (m *Endpoint_HealthCheckConfig) Validate() error

Validate checks the field values on Endpoint_HealthCheckConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*Endpoint_HealthCheckConfig) XXX_DiscardUnknown added in v0.5.0

func (m *Endpoint_HealthCheckConfig) XXX_DiscardUnknown()

func (*Endpoint_HealthCheckConfig) XXX_Marshal added in v0.5.0

func (m *Endpoint_HealthCheckConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Endpoint_HealthCheckConfig) XXX_Merge added in v0.5.0

func (dst *Endpoint_HealthCheckConfig) XXX_Merge(src proto.Message)

func (*Endpoint_HealthCheckConfig) XXX_Size added in v0.5.0

func (m *Endpoint_HealthCheckConfig) XXX_Size() int

func (*Endpoint_HealthCheckConfig) XXX_Unmarshal added in v0.5.0

func (m *Endpoint_HealthCheckConfig) XXX_Unmarshal(b []byte) error

type Endpoint_HealthCheckConfigValidationError

type Endpoint_HealthCheckConfigValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

Endpoint_HealthCheckConfigValidationError is the validation error returned by Endpoint_HealthCheckConfig.Validate if the designated constraints aren't met.

func (Endpoint_HealthCheckConfigValidationError) Error

Error satisfies the builtin error interface

type LbEndpoint

type LbEndpoint struct {
	// Upstream host identifier
	Endpoint *Endpoint `protobuf:"bytes,1,opt,name=endpoint" json:"endpoint,omitempty"`
	// 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" json:"metadata,omitempty"`
	// The optional load balancing weight of the upstream host, in the range 1 -
	// 128. 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.
	//
	// .. attention::
	//
	//   The limit of 128 is somewhat arbitrary, but is applied due to performance
	//   concerns with the current implementation and can be removed when
	//   `this issue <https://github.com/envoyproxy/envoy/issues/1285>`_ is fixed.
	LoadBalancingWeight  *types.UInt32Value `protobuf:"bytes,4,opt,name=load_balancing_weight,json=loadBalancingWeight" json:"load_balancing_weight,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

An Endpoint that Envoy can route traffic to.

func (*LbEndpoint) Descriptor

func (*LbEndpoint) Descriptor() ([]byte, []int)

func (*LbEndpoint) Equal added in v0.5.0

func (this *LbEndpoint) Equal(that interface{}) bool

func (*LbEndpoint) GetEndpoint

func (m *LbEndpoint) GetEndpoint() *Endpoint

func (*LbEndpoint) GetHealthStatus

func (m *LbEndpoint) GetHealthStatus() core.HealthStatus

func (*LbEndpoint) GetLoadBalancingWeight

func (m *LbEndpoint) GetLoadBalancingWeight() *types.UInt32Value

func (*LbEndpoint) GetMetadata

func (m *LbEndpoint) GetMetadata() *core.Metadata

func (*LbEndpoint) Marshal added in v0.5.0

func (m *LbEndpoint) Marshal() (dAtA []byte, err error)

func (*LbEndpoint) MarshalTo added in v0.5.0

func (m *LbEndpoint) MarshalTo(dAtA []byte) (int, error)

func (*LbEndpoint) ProtoMessage

func (*LbEndpoint) ProtoMessage()

func (*LbEndpoint) Reset

func (m *LbEndpoint) Reset()

func (*LbEndpoint) Size added in v0.5.0

func (m *LbEndpoint) Size() (n int)

func (*LbEndpoint) String

func (m *LbEndpoint) String() string

func (*LbEndpoint) Unmarshal added in v0.5.0

func (m *LbEndpoint) Unmarshal(dAtA []byte) error

func (*LbEndpoint) Validate

func (m *LbEndpoint) Validate() error

Validate checks the field values on LbEndpoint with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*LbEndpoint) XXX_DiscardUnknown added in v0.5.0

func (m *LbEndpoint) XXX_DiscardUnknown()

func (*LbEndpoint) XXX_Marshal added in v0.5.0

func (m *LbEndpoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LbEndpoint) XXX_Merge added in v0.5.0

func (dst *LbEndpoint) XXX_Merge(src proto.Message)

func (*LbEndpoint) XXX_Size added in v0.5.0

func (m *LbEndpoint) XXX_Size() int

func (*LbEndpoint) XXX_Unmarshal added in v0.5.0

func (m *LbEndpoint) XXX_Unmarshal(b []byte) error

type LbEndpointValidationError

type LbEndpointValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

LbEndpointValidationError is the validation error returned by LbEndpoint.Validate if the designated constraints aren't met.

func (LbEndpointValidationError) Error

Error satisfies the builtin error interface

type LocalityLbEndpoints

type LocalityLbEndpoints struct {
	// Identifies location of where the upstream hosts run.
	Locality *core.Locality `protobuf:"bytes,1,opt,name=locality" json:"locality,omitempty"`
	// The group of endpoints belonging to the locality specified.
	LbEndpoints []LbEndpoint `protobuf:"bytes,2,rep,name=lb_endpoints,json=lbEndpoints" json:"lb_endpoints"`
	// Optional: Per priority/region/zone/sub_zone weight - range 1-128. 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.
	//
	// 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
	// specificed when locality weighted load balancing is enabled, the cluster is
	// assumed to have a weight of 1.
	//
	// .. attention::
	//
	//   The limit of 128 is somewhat arbitrary, but is applied due to performance
	//   concerns with the current implementation and can be removed when
	//   `this issue <https://github.com/envoyproxy/envoy/issues/1285>`_ is fixed.
	LoadBalancingWeight *types.UInt32Value `protobuf:"bytes,3,opt,name=load_balancing_weight,json=loadBalancingWeight" 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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.

func (*LocalityLbEndpoints) Descriptor

func (*LocalityLbEndpoints) Descriptor() ([]byte, []int)

func (*LocalityLbEndpoints) Equal added in v0.5.0

func (this *LocalityLbEndpoints) Equal(that interface{}) bool

func (*LocalityLbEndpoints) GetLbEndpoints

func (m *LocalityLbEndpoints) GetLbEndpoints() []LbEndpoint

func (*LocalityLbEndpoints) GetLoadBalancingWeight

func (m *LocalityLbEndpoints) GetLoadBalancingWeight() *types.UInt32Value

func (*LocalityLbEndpoints) GetLocality

func (m *LocalityLbEndpoints) GetLocality() *core.Locality

func (*LocalityLbEndpoints) GetPriority

func (m *LocalityLbEndpoints) GetPriority() uint32

func (*LocalityLbEndpoints) Marshal added in v0.5.0

func (m *LocalityLbEndpoints) Marshal() (dAtA []byte, err error)

func (*LocalityLbEndpoints) MarshalTo added in v0.5.0

func (m *LocalityLbEndpoints) MarshalTo(dAtA []byte) (int, error)

func (*LocalityLbEndpoints) ProtoMessage

func (*LocalityLbEndpoints) ProtoMessage()

func (*LocalityLbEndpoints) Reset

func (m *LocalityLbEndpoints) Reset()

func (*LocalityLbEndpoints) Size added in v0.5.0

func (m *LocalityLbEndpoints) Size() (n int)

func (*LocalityLbEndpoints) String

func (m *LocalityLbEndpoints) String() string

func (*LocalityLbEndpoints) Unmarshal added in v0.5.0

func (m *LocalityLbEndpoints) Unmarshal(dAtA []byte) error

func (*LocalityLbEndpoints) Validate

func (m *LocalityLbEndpoints) Validate() error

Validate checks the field values on LocalityLbEndpoints with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*LocalityLbEndpoints) XXX_DiscardUnknown added in v0.5.0

func (m *LocalityLbEndpoints) XXX_DiscardUnknown()

func (*LocalityLbEndpoints) XXX_Marshal added in v0.5.0

func (m *LocalityLbEndpoints) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LocalityLbEndpoints) XXX_Merge added in v0.5.0

func (dst *LocalityLbEndpoints) XXX_Merge(src proto.Message)

func (*LocalityLbEndpoints) XXX_Size added in v0.5.0

func (m *LocalityLbEndpoints) XXX_Size() int

func (*LocalityLbEndpoints) XXX_Unmarshal added in v0.5.0

func (m *LocalityLbEndpoints) XXX_Unmarshal(b []byte) error

type LocalityLbEndpointsValidationError

type LocalityLbEndpointsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

LocalityLbEndpointsValidationError is the validation error returned by LocalityLbEndpoints.Validate if the designated constraints aren't met.

func (LocalityLbEndpointsValidationError) Error

Error satisfies the builtin error interface

type UpstreamEndpointStats

type UpstreamEndpointStats struct {
	// Upstream host address.
	Address *core.Address `protobuf:"bytes,1,opt,name=address" json:"address,omitempty"`
	// The total number of requests successfully completed by the endpoint. A
	// single HTTP or gRPC request or stream is counted as one request. A TCP
	// connection is also treated as one request. There is no explicit
	// total_requests field below for an endpoint, but it may be inferred from:
	//
	// .. code-block:: none
	//
	//   total_requests = total_successful_requests + total_requests_in_progress +
	//     total_error_requests
	//
	// 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"`
	// Stats for multi-dimensional load balancing.
	LoadMetricStats      []*EndpointLoadMetricStats `protobuf:"bytes,5,rep,name=load_metric_stats,json=loadMetricStats" json:"load_metric_stats,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

func (*UpstreamEndpointStats) Descriptor

func (*UpstreamEndpointStats) Descriptor() ([]byte, []int)

func (*UpstreamEndpointStats) GetAddress

func (m *UpstreamEndpointStats) GetAddress() *core.Address

func (*UpstreamEndpointStats) GetLoadMetricStats

func (m *UpstreamEndpointStats) GetLoadMetricStats() []*EndpointLoadMetricStats

func (*UpstreamEndpointStats) GetTotalErrorRequests

func (m *UpstreamEndpointStats) GetTotalErrorRequests() uint64

func (*UpstreamEndpointStats) GetTotalRequestsInProgress

func (m *UpstreamEndpointStats) GetTotalRequestsInProgress() uint64

func (*UpstreamEndpointStats) GetTotalSuccessfulRequests

func (m *UpstreamEndpointStats) GetTotalSuccessfulRequests() uint64

func (*UpstreamEndpointStats) Marshal added in v0.5.0

func (m *UpstreamEndpointStats) Marshal() (dAtA []byte, err error)

func (*UpstreamEndpointStats) MarshalTo added in v0.5.0

func (m *UpstreamEndpointStats) MarshalTo(dAtA []byte) (int, error)

func (*UpstreamEndpointStats) ProtoMessage

func (*UpstreamEndpointStats) ProtoMessage()

func (*UpstreamEndpointStats) Reset

func (m *UpstreamEndpointStats) Reset()

func (*UpstreamEndpointStats) Size added in v0.5.0

func (m *UpstreamEndpointStats) Size() (n int)

func (*UpstreamEndpointStats) String

func (m *UpstreamEndpointStats) String() string

func (*UpstreamEndpointStats) Unmarshal added in v0.5.0

func (m *UpstreamEndpointStats) Unmarshal(dAtA []byte) error

func (*UpstreamEndpointStats) Validate

func (m *UpstreamEndpointStats) Validate() error

Validate checks the field values on UpstreamEndpointStats with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*UpstreamEndpointStats) XXX_DiscardUnknown added in v0.5.0

func (m *UpstreamEndpointStats) XXX_DiscardUnknown()

func (*UpstreamEndpointStats) XXX_Marshal added in v0.5.0

func (m *UpstreamEndpointStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpstreamEndpointStats) XXX_Merge added in v0.5.0

func (dst *UpstreamEndpointStats) XXX_Merge(src proto.Message)

func (*UpstreamEndpointStats) XXX_Size added in v0.5.0

func (m *UpstreamEndpointStats) XXX_Size() int

func (*UpstreamEndpointStats) XXX_Unmarshal added in v0.5.0

func (m *UpstreamEndpointStats) XXX_Unmarshal(b []byte) error

type UpstreamEndpointStatsValidationError

type UpstreamEndpointStatsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

UpstreamEndpointStatsValidationError is the validation error returned by UpstreamEndpointStats.Validate if the designated constraints aren't met.

func (UpstreamEndpointStatsValidationError) Error

Error satisfies the builtin error interface

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" json:"locality,omitempty"`
	// The total number of requests sent by this Envoy since the last report. This
	// information is aggregated over all the upstream Endpoints. total_requests
	// can be inferred from:
	//
	// .. code-block:: none
	//
	//   total_requests = total_successful_requests + total_requests_in_progress +
	//     total_error_requests
	//
	// 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"`
	// Stats for multi-dimensional load balancing.
	LoadMetricStats []*EndpointLoadMetricStats `protobuf:"bytes,5,rep,name=load_metric_stats,json=loadMetricStats" 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_load_stats.LoadStatsResponse.report_endpoint_granularity>`.
	UpstreamEndpointStats []*UpstreamEndpointStats `protobuf:"bytes,7,rep,name=upstream_endpoint_stats,json=upstreamEndpointStats" json:"upstream_endpoint_stats,omitempty"`
	// [#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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

These are stats Envoy reports to GLB every so often. Report frequency is defined by :ref:`LoadStatsResponse.load_reporting_interval<envoy_api_field_load_stats.LoadStatsResponse.load_reporting_interval>`. Stats per upstream region/zone and optionally per subzone. [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.

func (*UpstreamLocalityStats) Descriptor

func (*UpstreamLocalityStats) Descriptor() ([]byte, []int)

func (*UpstreamLocalityStats) GetLoadMetricStats

func (m *UpstreamLocalityStats) GetLoadMetricStats() []*EndpointLoadMetricStats

func (*UpstreamLocalityStats) GetLocality

func (m *UpstreamLocalityStats) GetLocality() *core.Locality

func (*UpstreamLocalityStats) GetPriority

func (m *UpstreamLocalityStats) GetPriority() uint32

func (*UpstreamLocalityStats) GetTotalErrorRequests

func (m *UpstreamLocalityStats) GetTotalErrorRequests() uint64

func (*UpstreamLocalityStats) GetTotalRequestsInProgress

func (m *UpstreamLocalityStats) GetTotalRequestsInProgress() uint64

func (*UpstreamLocalityStats) GetTotalSuccessfulRequests

func (m *UpstreamLocalityStats) GetTotalSuccessfulRequests() uint64

func (*UpstreamLocalityStats) GetUpstreamEndpointStats

func (m *UpstreamLocalityStats) GetUpstreamEndpointStats() []*UpstreamEndpointStats

func (*UpstreamLocalityStats) Marshal added in v0.5.0

func (m *UpstreamLocalityStats) Marshal() (dAtA []byte, err error)

func (*UpstreamLocalityStats) MarshalTo added in v0.5.0

func (m *UpstreamLocalityStats) MarshalTo(dAtA []byte) (int, error)

func (*UpstreamLocalityStats) ProtoMessage

func (*UpstreamLocalityStats) ProtoMessage()

func (*UpstreamLocalityStats) Reset

func (m *UpstreamLocalityStats) Reset()

func (*UpstreamLocalityStats) Size added in v0.5.0

func (m *UpstreamLocalityStats) Size() (n int)

func (*UpstreamLocalityStats) String

func (m *UpstreamLocalityStats) String() string

func (*UpstreamLocalityStats) Unmarshal added in v0.5.0

func (m *UpstreamLocalityStats) Unmarshal(dAtA []byte) error

func (*UpstreamLocalityStats) Validate

func (m *UpstreamLocalityStats) Validate() error

Validate checks the field values on UpstreamLocalityStats with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*UpstreamLocalityStats) XXX_DiscardUnknown added in v0.5.0

func (m *UpstreamLocalityStats) XXX_DiscardUnknown()

func (*UpstreamLocalityStats) XXX_Marshal added in v0.5.0

func (m *UpstreamLocalityStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpstreamLocalityStats) XXX_Merge added in v0.5.0

func (dst *UpstreamLocalityStats) XXX_Merge(src proto.Message)

func (*UpstreamLocalityStats) XXX_Size added in v0.5.0

func (m *UpstreamLocalityStats) XXX_Size() int

func (*UpstreamLocalityStats) XXX_Unmarshal added in v0.5.0

func (m *UpstreamLocalityStats) XXX_Unmarshal(b []byte) error

type UpstreamLocalityStatsValidationError

type UpstreamLocalityStatsValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

UpstreamLocalityStatsValidationError is the validation error returned by UpstreamLocalityStats.Validate if the designated constraints aren't met.

func (UpstreamLocalityStatsValidationError) Error

Error satisfies the builtin error interface

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL