load_statsv2

Documentation

Index

• Variables
• type LoadStatsRequest
  • func (x *LoadStatsRequest) ClearNode()
  • func (x *LoadStatsRequest) GetClusterStats() []*endpoint.ClusterStats
  • func (x *LoadStatsRequest) GetNode() *core.Node
  • func (x *LoadStatsRequest) HasNode() bool
  • func (*LoadStatsRequest) ProtoMessage()
  • func (x *LoadStatsRequest) ProtoReflect() protoreflect.Message
  • func (x *LoadStatsRequest) Reset()
  • func (x *LoadStatsRequest) SetClusterStats(v []*endpoint.ClusterStats)
  • func (x *LoadStatsRequest) SetNode(v *core.Node)
  • func (x *LoadStatsRequest) String() string
• type LoadStatsRequest_builder
  • func (b0 LoadStatsRequest_builder) Build() *LoadStatsRequest
• type LoadStatsResponse
  • func (x *LoadStatsResponse) ClearLoadReportingInterval()
  • func (x *LoadStatsResponse) GetClusters() []string
  • func (x *LoadStatsResponse) GetLoadReportingInterval() *durationpb.Duration
  • func (x *LoadStatsResponse) GetReportEndpointGranularity() bool
  • func (x *LoadStatsResponse) GetSendAllClusters() bool
  • func (x *LoadStatsResponse) HasLoadReportingInterval() bool
  • func (*LoadStatsResponse) ProtoMessage()
  • func (x *LoadStatsResponse) ProtoReflect() protoreflect.Message
  • func (x *LoadStatsResponse) Reset()
  • func (x *LoadStatsResponse) SetClusters(v []string)
  • func (x *LoadStatsResponse) SetLoadReportingInterval(v *durationpb.Duration)
  • func (x *LoadStatsResponse) SetReportEndpointGranularity(v bool)
  • func (x *LoadStatsResponse) SetSendAllClusters(v bool)
  • func (x *LoadStatsResponse) String() string
• type LoadStatsResponse_builder
  • func (b0 LoadStatsResponse_builder) Build() *LoadStatsResponse

Variables

var File_envoy_service_load_stats_v2_lrs_proto protoreflect.FileDescriptor

Types

type LoadStatsRequest

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) ClearNode

func (x *LoadStatsRequest) ClearNode()

func (*LoadStatsRequest) GetClusterStats

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

func (*LoadStatsRequest) GetNode

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

func (*LoadStatsRequest) HasNode

func (x *LoadStatsRequest) HasNode() bool

func (*LoadStatsRequest) ProtoMessage

func (*LoadStatsRequest) ProtoMessage()

func (*LoadStatsRequest) ProtoReflect

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

func (*LoadStatsRequest) Reset

func (x *LoadStatsRequest) Reset()

func (*LoadStatsRequest) SetClusterStats

func (x *LoadStatsRequest) SetClusterStats(v []*endpoint.ClusterStats)

func (*LoadStatsRequest) SetNode

func (x *LoadStatsRequest) SetNode(v *core.Node)

func (*LoadStatsRequest) String

func (x *LoadStatsRequest) String() string

type LoadStatsRequest_builder

type LoadStatsRequest_builder struct {

	// Node identifier for Envoy instance.
	Node *core.Node
	// A list of load stats to report.
	ClusterStats []*endpoint.ClusterStats
	// contains filtered or unexported fields
}

func (LoadStatsRequest_builder) Build

func (b0 LoadStatsRequest_builder) Build() *LoadStatsRequest

type LoadStatsResponse

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 *durationpb.Duration `` /* 126-byte string literal not displayed */
	// Set to *true* if the management server supports endpoint granularity
	// report.
	ReportEndpointGranularity bool `` /* 139-byte string literal not displayed */
	// 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) ClearLoadReportingInterval

func (x *LoadStatsResponse) ClearLoadReportingInterval()

func (*LoadStatsResponse) GetClusters

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

func (*LoadStatsResponse) GetLoadReportingInterval

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

func (*LoadStatsResponse) GetReportEndpointGranularity

func (x *LoadStatsResponse) GetReportEndpointGranularity() bool

func (*LoadStatsResponse) GetSendAllClusters

func (x *LoadStatsResponse) GetSendAllClusters() bool

func (*LoadStatsResponse) HasLoadReportingInterval

func (x *LoadStatsResponse) HasLoadReportingInterval() bool

func (*LoadStatsResponse) ProtoMessage

func (*LoadStatsResponse) ProtoMessage()

func (*LoadStatsResponse) ProtoReflect

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

func (*LoadStatsResponse) Reset

func (x *LoadStatsResponse) Reset()

func (*LoadStatsResponse) SetClusters

func (x *LoadStatsResponse) SetClusters(v []string)

func (*LoadStatsResponse) SetLoadReportingInterval

func (x *LoadStatsResponse) SetLoadReportingInterval(v *durationpb.Duration)

func (*LoadStatsResponse) SetReportEndpointGranularity

func (x *LoadStatsResponse) SetReportEndpointGranularity(v bool)

func (*LoadStatsResponse) SetSendAllClusters

func (x *LoadStatsResponse) SetSendAllClusters(v bool)

func (*LoadStatsResponse) String

func (x *LoadStatsResponse) String() string

type LoadStatsResponse_builder

type LoadStatsResponse_builder struct {

	// Clusters to report stats for.
	// Not populated if *send_all_clusters* is true.
	Clusters []string
	// 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
	// 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 *durationpb.Duration
	// Set to *true* if the management server supports endpoint granularity
	// report.
	ReportEndpointGranularity bool
	// contains filtered or unexported fields
}

func (LoadStatsResponse_builder) Build

func (b0 LoadStatsResponse_builder) Build() *LoadStatsResponse