go-control-plane: github.com/envoyproxy/go-control-plane/envoy/service/load_stats/v2 Index | Files

package envoy_service_load_stats_v2

import "github.com/envoyproxy/go-control-plane/envoy/service/load_stats/v2"

Index

Package Files

lrs.pb.go lrs.pb.validate.go

Variables

var File_envoy_service_load_stats_v2_lrs_proto protoreflect.FileDescriptor

func RegisterLoadReportingServiceServer Uses

func RegisterLoadReportingServiceServer(s *grpc.Server, srv LoadReportingServiceServer)

type LoadReportingServiceClient Uses

type LoadReportingServiceClient interface {
    // Advanced API to allow for multi-dimensional load balancing by remote
    // server. For receiving LB assignments, the steps are:
    // 1, The management server is configured with per cluster/zone/load metric
    //    capacity configuration. The capacity configuration definition is
    //    outside of the scope of this document.
    // 2. Envoy issues a standard {Stream,Fetch}Endpoints request for the clusters
    //    to balance.
    //
    // Independently, Envoy will initiate a StreamLoadStats bidi stream with a
    // management server:
    // 1. Once a connection establishes, the management server publishes a
    //    LoadStatsResponse for all clusters it is interested in learning load
    //    stats about.
    // 2. For each cluster, Envoy load balances incoming traffic to upstream hosts
    //    based on per-zone weights and/or per-instance weights (if specified)
    //    based on intra-zone LbPolicy. This information comes from the above
    //    {Stream,Fetch}Endpoints.
    // 3. When upstream hosts reply, they optionally add header <define header
    //    name> with ASCII representation of EndpointLoadMetricStats.
    // 4. Envoy aggregates load reports over the period of time given to it in
    //    LoadStatsResponse.load_reporting_interval. This includes aggregation
    //    stats Envoy maintains by itself (total_requests, rpc_errors etc.) as
    //    well as load metrics from upstream hosts.
    // 5. When the timer of load_reporting_interval expires, Envoy sends new
    //    LoadStatsRequest filled with load reports for each cluster.
    // 6. The management server uses the load reports from all reported Envoys
    //    from around the world, computes global assignment and prepares traffic
    //    assignment destined for each zone Envoys are located in. Goto 2.
    StreamLoadStats(ctx context.Context, opts ...grpc.CallOption) (LoadReportingService_StreamLoadStatsClient, error)
}

LoadReportingServiceClient is the client API for LoadReportingService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewLoadReportingServiceClient Uses

func NewLoadReportingServiceClient(cc grpc.ClientConnInterface) LoadReportingServiceClient

type LoadReportingServiceServer Uses

type LoadReportingServiceServer interface {
    // Advanced API to allow for multi-dimensional load balancing by remote
    // server. For receiving LB assignments, the steps are:
    // 1, The management server is configured with per cluster/zone/load metric
    //    capacity configuration. The capacity configuration definition is
    //    outside of the scope of this document.
    // 2. Envoy issues a standard {Stream,Fetch}Endpoints request for the clusters
    //    to balance.
    //
    // Independently, Envoy will initiate a StreamLoadStats bidi stream with a
    // management server:
    // 1. Once a connection establishes, the management server publishes a
    //    LoadStatsResponse for all clusters it is interested in learning load
    //    stats about.
    // 2. For each cluster, Envoy load balances incoming traffic to upstream hosts
    //    based on per-zone weights and/or per-instance weights (if specified)
    //    based on intra-zone LbPolicy. This information comes from the above
    //    {Stream,Fetch}Endpoints.
    // 3. When upstream hosts reply, they optionally add header <define header
    //    name> with ASCII representation of EndpointLoadMetricStats.
    // 4. Envoy aggregates load reports over the period of time given to it in
    //    LoadStatsResponse.load_reporting_interval. This includes aggregation
    //    stats Envoy maintains by itself (total_requests, rpc_errors etc.) as
    //    well as load metrics from upstream hosts.
    // 5. When the timer of load_reporting_interval expires, Envoy sends new
    //    LoadStatsRequest filled with load reports for each cluster.
    // 6. The management server uses the load reports from all reported Envoys
    //    from around the world, computes global assignment and prepares traffic
    //    assignment destined for each zone Envoys are located in. Goto 2.
    StreamLoadStats(LoadReportingService_StreamLoadStatsServer) error
}

LoadReportingServiceServer is the server API for LoadReportingService service.

type LoadReportingService_StreamLoadStatsClient Uses

type LoadReportingService_StreamLoadStatsClient interface {
    Send(*LoadStatsRequest) error
    Recv() (*LoadStatsResponse, error)
    grpc.ClientStream
}

type LoadReportingService_StreamLoadStatsServer Uses

type LoadReportingService_StreamLoadStatsServer interface {
    Send(*LoadStatsResponse) error
    Recv() (*LoadStatsRequest, error)
    grpc.ServerStream
}

type LoadStatsRequest Uses

type LoadStatsRequest struct {

    // Node identifier for Envoy instance.
    Node *core.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
    // A list of load stats to report.
    ClusterStats []*endpoint.ClusterStats `protobuf:"bytes,2,rep,name=cluster_stats,json=clusterStats,proto3" json:"cluster_stats,omitempty"`
    // contains filtered or unexported fields
}

A load report Envoy sends to the management server. [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.

func (*LoadStatsRequest) Descriptor Uses

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

Deprecated: Use LoadStatsRequest.ProtoReflect.Descriptor instead.

func (*LoadStatsRequest) GetClusterStats Uses

func (x *LoadStatsRequest) GetClusterStats() []*endpoint.ClusterStats

func (*LoadStatsRequest) GetNode Uses

func (x *LoadStatsRequest) GetNode() *core.Node

func (*LoadStatsRequest) ProtoMessage Uses

func (*LoadStatsRequest) ProtoMessage()

func (*LoadStatsRequest) ProtoReflect Uses

func (x *LoadStatsRequest) ProtoReflect() protoreflect.Message

func (*LoadStatsRequest) Reset Uses

func (x *LoadStatsRequest) Reset()

func (*LoadStatsRequest) String Uses

func (x *LoadStatsRequest) String() string

func (*LoadStatsRequest) Validate Uses

func (m *LoadStatsRequest) Validate() error

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

type LoadStatsRequestValidationError Uses

type LoadStatsRequestValidationError struct {
    // contains filtered or unexported fields
}

LoadStatsRequestValidationError is the validation error returned by LoadStatsRequest.Validate if the designated constraints aren't met.

func (LoadStatsRequestValidationError) Cause Uses

func (e LoadStatsRequestValidationError) Cause() error

Cause function returns cause value.

func (LoadStatsRequestValidationError) Error Uses

func (e LoadStatsRequestValidationError) Error() string

Error satisfies the builtin error interface

func (LoadStatsRequestValidationError) ErrorName Uses

func (e LoadStatsRequestValidationError) ErrorName() string

ErrorName returns error name.

func (LoadStatsRequestValidationError) Field Uses

func (e LoadStatsRequestValidationError) Field() string

Field function returns field value.

func (LoadStatsRequestValidationError) Key Uses

func (e LoadStatsRequestValidationError) Key() bool

Key function returns key value.

func (LoadStatsRequestValidationError) Reason Uses

func (e LoadStatsRequestValidationError) Reason() string

Reason function returns reason value.

type LoadStatsResponse Uses

type LoadStatsResponse struct {

    // Clusters to report stats for.
    // Not populated if *send_all_clusters* is true.
    Clusters []string `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
    // If true, the client should send all clusters it knows about.
    // Only clients that advertise the "envoy.lrs.supports_send_all_clusters" capability in their
    // :ref:`client_features<envoy_api_field_core.Node.client_features>` field will honor this field.
    SendAllClusters bool `protobuf:"varint,4,opt,name=send_all_clusters,json=sendAllClusters,proto3" json:"send_all_clusters,omitempty"`
    // The minimum interval of time to collect stats over. This is only a minimum for two reasons:
    // 1. There may be some delay from when the timer fires until stats sampling occurs.
    // 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    //    that is observed in between the corresponding previous *LoadStatsRequest* and this
    //    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    //    of inobservability that might otherwise exists between the messages. New clusters are not
    //    subject to this consideration.
    LoadReportingInterval *duration.Duration `protobuf:"bytes,2,opt,name=load_reporting_interval,json=loadReportingInterval,proto3" json:"load_reporting_interval,omitempty"`
    // Set to *true* if the management server supports endpoint granularity
    // report.
    ReportEndpointGranularity bool `protobuf:"varint,3,opt,name=report_endpoint_granularity,json=reportEndpointGranularity,proto3" json:"report_endpoint_granularity,omitempty"`
    // contains filtered or unexported fields
}

The management server sends envoy a LoadStatsResponse with all clusters it is interested in learning load stats about. [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.

func (*LoadStatsResponse) Descriptor Uses

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

Deprecated: Use LoadStatsResponse.ProtoReflect.Descriptor instead.

func (*LoadStatsResponse) GetClusters Uses

func (x *LoadStatsResponse) GetClusters() []string

func (*LoadStatsResponse) GetLoadReportingInterval Uses

func (x *LoadStatsResponse) GetLoadReportingInterval() *duration.Duration

func (*LoadStatsResponse) GetReportEndpointGranularity Uses

func (x *LoadStatsResponse) GetReportEndpointGranularity() bool

func (*LoadStatsResponse) GetSendAllClusters Uses

func (x *LoadStatsResponse) GetSendAllClusters() bool

func (*LoadStatsResponse) ProtoMessage Uses

func (*LoadStatsResponse) ProtoMessage()

func (*LoadStatsResponse) ProtoReflect Uses

func (x *LoadStatsResponse) ProtoReflect() protoreflect.Message

func (*LoadStatsResponse) Reset Uses

func (x *LoadStatsResponse) Reset()

func (*LoadStatsResponse) String Uses

func (x *LoadStatsResponse) String() string

func (*LoadStatsResponse) Validate Uses

func (m *LoadStatsResponse) Validate() error

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

type LoadStatsResponseValidationError Uses

type LoadStatsResponseValidationError struct {
    // contains filtered or unexported fields
}

LoadStatsResponseValidationError is the validation error returned by LoadStatsResponse.Validate if the designated constraints aren't met.

func (LoadStatsResponseValidationError) Cause Uses

func (e LoadStatsResponseValidationError) Cause() error

Cause function returns cause value.

func (LoadStatsResponseValidationError) Error Uses

func (e LoadStatsResponseValidationError) Error() string

Error satisfies the builtin error interface

func (LoadStatsResponseValidationError) ErrorName Uses

func (e LoadStatsResponseValidationError) ErrorName() string

ErrorName returns error name.

func (LoadStatsResponseValidationError) Field Uses

func (e LoadStatsResponseValidationError) Field() string

Field function returns field value.

func (LoadStatsResponseValidationError) Key Uses

func (e LoadStatsResponseValidationError) Key() bool

Key function returns key value.

func (LoadStatsResponseValidationError) Reason Uses

func (e LoadStatsResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedLoadReportingServiceServer Uses

type UnimplementedLoadReportingServiceServer struct {
}

UnimplementedLoadReportingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedLoadReportingServiceServer) StreamLoadStats Uses

func (*UnimplementedLoadReportingServiceServer) StreamLoadStats(LoadReportingService_StreamLoadStatsServer) error

Package envoy_service_load_stats_v2 imports 25 packages (graph) and is imported by 18 packages. Updated 2021-01-08. Refresh now. Tools for package owners.