cluster

package
v1.32.0-20240321201358... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_api_v2_cluster_circuit_breaker_proto protoreflect.FileDescriptor
View Source 
var File_envoy_api_v2_cluster_filter_proto protoreflect.FileDescriptor
View Source 
var File_envoy_api_v2_cluster_outlier_detection_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CircuitBreakers 

type CircuitBreakers struct {

	// If multiple :ref:`Thresholds<envoy_api_msg_cluster.CircuitBreakers.Thresholds>`
	// are defined with the same :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`,
	// the first one in the list is used. If no Thresholds is defined for a given
	// :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`, the default values
	// are used.
	Thresholds []*CircuitBreakers_Thresholds `protobuf:"bytes,1,rep,name=thresholds,proto3" json:"thresholds,omitempty"`
	// contains filtered or unexported fields
}

:ref:`Circuit breaking<arch_overview_circuit_break>` settings can be specified individually for each defined priority.

func (*CircuitBreakers) Descriptor deprecated 

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

Deprecated: Use CircuitBreakers.ProtoReflect.Descriptor instead.

func (*CircuitBreakers) GetThresholds 

func (x *CircuitBreakers) GetThresholds() []*CircuitBreakers_Thresholds

func (*CircuitBreakers) ProtoMessage 

func (*CircuitBreakers) ProtoMessage()

func (*CircuitBreakers) ProtoReflect 

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

func (*CircuitBreakers) Reset 

func (x *CircuitBreakers) Reset()

func (*CircuitBreakers) String 

func (x *CircuitBreakers) String() string

type CircuitBreakers_Thresholds 

type CircuitBreakers_Thresholds struct {

	// The :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`
	// the specified CircuitBreaker settings apply to.
	Priority core.RoutingPriority `protobuf:"varint,1,opt,name=priority,proto3,enum=envoy.api.v2.core.RoutingPriority" json:"priority,omitempty"`
	// The maximum number of connections that Envoy will make to the upstream
	// cluster. If not specified, the default is 1024.
	MaxConnections *wrapperspb.UInt32Value `protobuf:"bytes,2,opt,name=max_connections,json=maxConnections,proto3" json:"max_connections,omitempty"`
	// The maximum number of pending requests that Envoy will allow to the
	// upstream cluster. If not specified, the default is 1024.
	MaxPendingRequests *wrapperspb.UInt32Value `protobuf:"bytes,3,opt,name=max_pending_requests,json=maxPendingRequests,proto3" json:"max_pending_requests,omitempty"`
	// The maximum number of parallel requests that Envoy will make to the
	// upstream cluster. If not specified, the default is 1024.
	MaxRequests *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=max_requests,json=maxRequests,proto3" json:"max_requests,omitempty"`
	// The maximum number of parallel retries that Envoy will allow to the
	// upstream cluster. If not specified, the default is 3.
	MaxRetries *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=max_retries,json=maxRetries,proto3" json:"max_retries,omitempty"`
	// Specifies a limit on concurrent retries in relation to the number of active requests. This
	// parameter is optional.
	//
	// .. note::
	//
	//	If this field is set, the retry budget will override any configured retry circuit
	//	breaker.
	RetryBudget *CircuitBreakers_Thresholds_RetryBudget `protobuf:"bytes,8,opt,name=retry_budget,json=retryBudget,proto3" json:"retry_budget,omitempty"`
	// If track_remaining is true, then stats will be published that expose
	// the number of resources remaining until the circuit breakers open. If
	// not specified, the default is false.
	//
	// .. note::
	//
	//	If a retry budget is used in lieu of the max_retries circuit breaker,
	//	the remaining retry resources remaining will not be tracked.
	TrackRemaining bool `protobuf:"varint,6,opt,name=track_remaining,json=trackRemaining,proto3" json:"track_remaining,omitempty"`
	// The maximum number of connection pools per cluster that Envoy will concurrently support at
	// once. If not specified, the default is unlimited. Set this for clusters which create a
	// large number of connection pools. See
	// :ref:`Circuit Breaking <arch_overview_circuit_break_cluster_maximum_connection_pools>` for
	// more details.
	MaxConnectionPools *wrapperspb.UInt32Value `protobuf:"bytes,7,opt,name=max_connection_pools,json=maxConnectionPools,proto3" json:"max_connection_pools,omitempty"`
	// contains filtered or unexported fields
}

A Thresholds defines CircuitBreaker settings for a :ref:`RoutingPriority<envoy_api_enum_core.RoutingPriority>`. [#next-free-field: 9]

func (*CircuitBreakers_Thresholds) Descriptor deprecated 

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

Deprecated: Use CircuitBreakers_Thresholds.ProtoReflect.Descriptor instead.

func (*CircuitBreakers_Thresholds) GetMaxConnectionPools 

func (x *CircuitBreakers_Thresholds) GetMaxConnectionPools() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds) GetMaxConnections 

func (x *CircuitBreakers_Thresholds) GetMaxConnections() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds) GetMaxPendingRequests 

func (x *CircuitBreakers_Thresholds) GetMaxPendingRequests() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds) GetMaxRequests 

func (x *CircuitBreakers_Thresholds) GetMaxRequests() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds) GetMaxRetries 

func (x *CircuitBreakers_Thresholds) GetMaxRetries() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds) GetPriority 

func (x *CircuitBreakers_Thresholds) GetPriority() core.RoutingPriority

func (*CircuitBreakers_Thresholds) GetRetryBudget 

func (x *CircuitBreakers_Thresholds) GetRetryBudget() *CircuitBreakers_Thresholds_RetryBudget

func (*CircuitBreakers_Thresholds) GetTrackRemaining 

func (x *CircuitBreakers_Thresholds) GetTrackRemaining() bool

func (*CircuitBreakers_Thresholds) ProtoMessage 

func (*CircuitBreakers_Thresholds) ProtoMessage()

func (*CircuitBreakers_Thresholds) ProtoReflect 

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

func (*CircuitBreakers_Thresholds) Reset 

func (x *CircuitBreakers_Thresholds) Reset()

func (*CircuitBreakers_Thresholds) String 

func (x *CircuitBreakers_Thresholds) String() string

type CircuitBreakers_Thresholds_RetryBudget 

type CircuitBreakers_Thresholds_RetryBudget struct {

	// Specifies the limit on concurrent retries as a percentage of the sum of active requests and
	// active pending requests. For example, if there are 100 active requests and the
	// budget_percent is set to 25, there may be 25 active retries.
	//
	// This parameter is optional. Defaults to 20%.
	BudgetPercent *_type.Percent `protobuf:"bytes,1,opt,name=budget_percent,json=budgetPercent,proto3" json:"budget_percent,omitempty"`
	// Specifies the minimum retry concurrency allowed for the retry budget. The limit on the
	// number of active retries may never go below this number.
	//
	// This parameter is optional. Defaults to 3.
	MinRetryConcurrency *wrapperspb.UInt32Value `protobuf:"bytes,2,opt,name=min_retry_concurrency,json=minRetryConcurrency,proto3" json:"min_retry_concurrency,omitempty"`
	// contains filtered or unexported fields
}

func (*CircuitBreakers_Thresholds_RetryBudget) Descriptor deprecated 

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

Deprecated: Use CircuitBreakers_Thresholds_RetryBudget.ProtoReflect.Descriptor instead.

func (*CircuitBreakers_Thresholds_RetryBudget) GetBudgetPercent 

func (x *CircuitBreakers_Thresholds_RetryBudget) GetBudgetPercent() *_type.Percent

func (*CircuitBreakers_Thresholds_RetryBudget) GetMinRetryConcurrency 

func (x *CircuitBreakers_Thresholds_RetryBudget) GetMinRetryConcurrency() *wrapperspb.UInt32Value

func (*CircuitBreakers_Thresholds_RetryBudget) ProtoMessage 

func (*CircuitBreakers_Thresholds_RetryBudget) ProtoMessage()

func (*CircuitBreakers_Thresholds_RetryBudget) ProtoReflect 

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

func (*CircuitBreakers_Thresholds_RetryBudget) Reset 

func (x *CircuitBreakers_Thresholds_RetryBudget) Reset()

func (*CircuitBreakers_Thresholds_RetryBudget) String 

func (x *CircuitBreakers_Thresholds_RetryBudget) String() string

type Filter 

type Filter struct {

	// The name of the filter to instantiate. The name must match a
	// :ref:`supported filter <config_network_filters>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	TypedConfig *anypb.Any `protobuf:"bytes,2,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"`
	// contains filtered or unexported fields
}

func (*Filter) Descriptor deprecated 

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

Deprecated: Use Filter.ProtoReflect.Descriptor instead.

func (*Filter) GetName 

func (x *Filter) GetName() string

func (*Filter) GetTypedConfig 

func (x *Filter) GetTypedConfig() *anypb.Any

func (*Filter) ProtoMessage 

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect 

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

func (*Filter) Reset 

func (x *Filter) Reset()

func (*Filter) String 

func (x *Filter) String() string

type OutlierDetection 

type OutlierDetection struct {

	// The number of consecutive server-side error responses (for HTTP traffic,
	// 5xx responses; for TCP traffic, connection failures; for Redis, failure to
	// respond PONG; etc.) before a consecutive 5xx ejection occurs. Defaults to 5.
	Consecutive_5Xx *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=consecutive_5xx,json=consecutive5xx,proto3" json:"consecutive_5xx,omitempty"`
	// The time interval between ejection analysis sweeps. This can result in
	// both new ejections as well as hosts being returned to service. Defaults
	// to 10000ms or 10s.
	Interval *durationpb.Duration `protobuf:"bytes,2,opt,name=interval,proto3" json:"interval,omitempty"`
	// The base time that a host is ejected for. The real time is equal to the
	// base time multiplied by the number of times the host has been ejected.
	// Defaults to 30000ms or 30s.
	BaseEjectionTime *durationpb.Duration `protobuf:"bytes,3,opt,name=base_ejection_time,json=baseEjectionTime,proto3" json:"base_ejection_time,omitempty"`
	// The maximum % of an upstream cluster that can be ejected due to outlier
	// detection. Defaults to 10% but will eject at least one host regardless of the value.
	MaxEjectionPercent *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=max_ejection_percent,json=maxEjectionPercent,proto3" json:"max_ejection_percent,omitempty"`
	// The % chance that a host will be actually ejected when an outlier status
	// is detected through consecutive 5xx. This setting can be used to disable
	// ejection or to ramp it up slowly. Defaults to 100.
	EnforcingConsecutive_5Xx *wrapperspb.UInt32Value `` /* 132-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status
	// is detected through success rate statistics. This setting can be used to
	// disable ejection or to ramp it up slowly. Defaults to 100.
	EnforcingSuccessRate *wrapperspb.UInt32Value `protobuf:"bytes,6,opt,name=enforcing_success_rate,json=enforcingSuccessRate,proto3" json:"enforcing_success_rate,omitempty"`
	// The number of hosts in a cluster that must have enough request volume to
	// detect success rate outliers. If the number of hosts is less than this
	// setting, outlier detection via success rate statistics is not performed
	// for any host in the cluster. Defaults to 5.
	SuccessRateMinimumHosts *wrapperspb.UInt32Value `` /* 134-byte string literal not displayed */
	// The minimum number of total requests that must be collected in one
	// interval (as defined by the interval duration above) to include this host
	// in success rate based outlier detection. If the volume is lower than this
	// setting, outlier detection via success rate statistics is not performed
	// for that host. Defaults to 100.
	SuccessRateRequestVolume *wrapperspb.UInt32Value `` /* 137-byte string literal not displayed */
	// This factor is used to determine the ejection threshold for success rate
	// outlier ejection. The ejection threshold is the difference between the
	// mean success rate, and the product of this factor and the standard
	// deviation of the mean success rate: mean - (stdev *
	// success_rate_stdev_factor). This factor is divided by a thousand to get a
	// double. That is, if the desired factor is 1.9, the runtime value should
	// be 1900. Defaults to 1900.
	SuccessRateStdevFactor *wrapperspb.UInt32Value `` /* 131-byte string literal not displayed */
	// The number of consecutive gateway failures (502, 503, 504 status codes)
	// before a consecutive gateway failure ejection occurs. Defaults to 5.
	ConsecutiveGatewayFailure *wrapperspb.UInt32Value `` /* 139-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status
	// is detected through consecutive gateway failures. This setting can be
	// used to disable ejection or to ramp it up slowly. Defaults to 0.
	EnforcingConsecutiveGatewayFailure *wrapperspb.UInt32Value `` /* 168-byte string literal not displayed */
	// Determines whether to distinguish local origin failures from external errors. If set to true
	// the following configuration parameters are taken into account:
	// :ref:`consecutive_local_origin_failure<envoy_api_field_cluster.OutlierDetection.consecutive_local_origin_failure>`,
	// :ref:`enforcing_consecutive_local_origin_failure<envoy_api_field_cluster.OutlierDetection.enforcing_consecutive_local_origin_failure>`
	// and
	// :ref:`enforcing_local_origin_success_rate<envoy_api_field_cluster.OutlierDetection.enforcing_local_origin_success_rate>`.
	// Defaults to false.
	SplitExternalLocalOriginErrors bool `` /* 159-byte string literal not displayed */
	// The number of consecutive locally originated failures before ejection
	// occurs. Defaults to 5. Parameter takes effect only when
	// :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
	// is set to true.
	ConsecutiveLocalOriginFailure *wrapperspb.UInt32Value `` /* 153-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status
	// is detected through consecutive locally originated failures. This setting can be
	// used to disable ejection or to ramp it up slowly. Defaults to 100.
	// Parameter takes effect only when
	// :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
	// is set to true.
	EnforcingConsecutiveLocalOriginFailure *wrapperspb.UInt32Value `` /* 182-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status
	// is detected through success rate statistics for locally originated errors.
	// This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
	// Parameter takes effect only when
	// :ref:`split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
	// is set to true.
	EnforcingLocalOriginSuccessRate *wrapperspb.UInt32Value `` /* 161-byte string literal not displayed */
	// The failure percentage to use when determining failure percentage-based outlier detection. If
	// the failure percentage of a given host is greater than or equal to this value, it will be
	// ejected. Defaults to 85.
	FailurePercentageThreshold *wrapperspb.UInt32Value `` /* 142-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status is detected through
	// failure percentage statistics. This setting can be used to disable ejection or to ramp it up
	// slowly. Defaults to 0.
	//
	// [#next-major-version: setting this without setting failure_percentage_threshold should be
	// invalid in v4.]
	EnforcingFailurePercentage *wrapperspb.UInt32Value `` /* 142-byte string literal not displayed */
	// The % chance that a host will be actually ejected when an outlier status is detected through
	// local-origin failure percentage statistics. This setting can be used to disable ejection or to
	// ramp it up slowly. Defaults to 0.
	EnforcingFailurePercentageLocalOrigin *wrapperspb.UInt32Value `` /* 179-byte string literal not displayed */
	// The minimum number of hosts in a cluster in order to perform failure percentage-based ejection.
	// If the total number of hosts in the cluster is less than this value, failure percentage-based
	// ejection will not be performed. Defaults to 5.
	FailurePercentageMinimumHosts *wrapperspb.UInt32Value `` /* 153-byte string literal not displayed */
	// The minimum number of total requests that must be collected in one interval (as defined by the
	// interval duration above) to perform failure percentage-based ejection for this host. If the
	// volume is lower than this setting, failure percentage-based ejection will not be performed for
	// this host. Defaults to 50.
	FailurePercentageRequestVolume *wrapperspb.UInt32Value `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

See the :ref:`architecture overview <arch_overview_outlier_detection>` for more information on outlier detection. [#next-free-field: 21]

func (*OutlierDetection) Descriptor deprecated 

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

Deprecated: Use OutlierDetection.ProtoReflect.Descriptor instead.

func (*OutlierDetection) GetBaseEjectionTime 

func (x *OutlierDetection) GetBaseEjectionTime() *durationpb.Duration

func (*OutlierDetection) GetConsecutiveGatewayFailure 

func (x *OutlierDetection) GetConsecutiveGatewayFailure() *wrapperspb.UInt32Value

func (*OutlierDetection) GetConsecutiveLocalOriginFailure 

func (x *OutlierDetection) GetConsecutiveLocalOriginFailure() *wrapperspb.UInt32Value

func (*OutlierDetection) GetConsecutive_5Xx 

func (x *OutlierDetection) GetConsecutive_5Xx() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingConsecutiveGatewayFailure 

func (x *OutlierDetection) GetEnforcingConsecutiveGatewayFailure() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingConsecutiveLocalOriginFailure 

func (x *OutlierDetection) GetEnforcingConsecutiveLocalOriginFailure() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingConsecutive_5Xx 

func (x *OutlierDetection) GetEnforcingConsecutive_5Xx() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingFailurePercentage 

func (x *OutlierDetection) GetEnforcingFailurePercentage() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingFailurePercentageLocalOrigin 

func (x *OutlierDetection) GetEnforcingFailurePercentageLocalOrigin() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingLocalOriginSuccessRate 

func (x *OutlierDetection) GetEnforcingLocalOriginSuccessRate() *wrapperspb.UInt32Value

func (*OutlierDetection) GetEnforcingSuccessRate 

func (x *OutlierDetection) GetEnforcingSuccessRate() *wrapperspb.UInt32Value

func (*OutlierDetection) GetFailurePercentageMinimumHosts 

func (x *OutlierDetection) GetFailurePercentageMinimumHosts() *wrapperspb.UInt32Value

func (*OutlierDetection) GetFailurePercentageRequestVolume 

func (x *OutlierDetection) GetFailurePercentageRequestVolume() *wrapperspb.UInt32Value

func (*OutlierDetection) GetFailurePercentageThreshold 

func (x *OutlierDetection) GetFailurePercentageThreshold() *wrapperspb.UInt32Value

func (*OutlierDetection) GetInterval 

func (x *OutlierDetection) GetInterval() *durationpb.Duration

func (*OutlierDetection) GetMaxEjectionPercent 

func (x *OutlierDetection) GetMaxEjectionPercent() *wrapperspb.UInt32Value

func (*OutlierDetection) GetSplitExternalLocalOriginErrors 

func (x *OutlierDetection) GetSplitExternalLocalOriginErrors() bool

func (*OutlierDetection) GetSuccessRateMinimumHosts 

func (x *OutlierDetection) GetSuccessRateMinimumHosts() *wrapperspb.UInt32Value

func (*OutlierDetection) GetSuccessRateRequestVolume 

func (x *OutlierDetection) GetSuccessRateRequestVolume() *wrapperspb.UInt32Value

func (*OutlierDetection) GetSuccessRateStdevFactor 

func (x *OutlierDetection) GetSuccessRateStdevFactor() *wrapperspb.UInt32Value

func (*OutlierDetection) ProtoMessage 

func (*OutlierDetection) ProtoMessage()

func (*OutlierDetection) ProtoReflect 

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

func (*OutlierDetection) Reset 

func (x *OutlierDetection) Reset()

func (*OutlierDetection) String 

func (x *OutlierDetection) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.