envoy_config_retry_previous_priorities

Documentation

Index

• Variables
• type PreviousPrioritiesConfig
  • func (*PreviousPrioritiesConfig) Descriptor() ([]byte, []int)
  • func (x *PreviousPrioritiesConfig) GetUpdateFrequency() int32
  • func (*PreviousPrioritiesConfig) ProtoMessage()
  • func (x *PreviousPrioritiesConfig) ProtoReflect() protoreflect.Message
  • func (x *PreviousPrioritiesConfig) Reset()
  • func (x *PreviousPrioritiesConfig) String() string
  • func (m *PreviousPrioritiesConfig) Validate() error
  • func (m *PreviousPrioritiesConfig) ValidateAll() error
• type PreviousPrioritiesConfigMultiError
  • func (m PreviousPrioritiesConfigMultiError) AllErrors() []error
  • func (m PreviousPrioritiesConfigMultiError) Error() string
• type PreviousPrioritiesConfigValidationError
  • func (e PreviousPrioritiesConfigValidationError) Cause() error
  • func (e PreviousPrioritiesConfigValidationError) Error() string
  • func (e PreviousPrioritiesConfigValidationError) ErrorName() string
  • func (e PreviousPrioritiesConfigValidationError) Field() string
  • func (e PreviousPrioritiesConfigValidationError) Key() bool
  • func (e PreviousPrioritiesConfigValidationError) Reason() string

Variables

var File_envoy_config_retry_previous_priorities_previous_priorities_config_proto protoreflect.FileDescriptor

Types

type PreviousPrioritiesConfig

type PreviousPrioritiesConfig struct {

	// How often the priority load should be updated based on previously attempted priorities. Useful
	// to allow each priorities to receive more than one request before being excluded or to reduce
	// the number of times that the priority load has to be recomputed.
	//
	// For example, by setting this to 2, then the first two attempts (initial attempt and first
	// retry) will use the unmodified priority load. The third and fourth attempt will use priority
	// load which excludes the priorities routed to with the first two attempts, and the fifth and
	// sixth attempt will use the priority load excluding the priorities used for the first four
	// attempts.
	//
	// Must be greater than 0.
	UpdateFrequency int32 `protobuf:"varint,1,opt,name=update_frequency,json=updateFrequency,proto3" json:"update_frequency,omitempty"`
	// contains filtered or unexported fields
}

A retry host selector that attempts to spread retries between priorities, even if certain priorities would not normally be attempted due to higher priorities being available.

As priorities get excluded, load will be distributed amongst the remaining healthy priorities based on the relative health of the priorities, matching how load is distributed during regular host selection. For example, given priority healths of {100, 50, 50}, the original load will be {100, 0, 0} (since P0 has capacity to handle 100% of the traffic). If P0 is excluded, the load changes to {0, 50, 50}, because P1 is only able to handle 50% of the traffic, causing the remaining to spill over to P2.

Each priority attempted will be excluded until there are no healthy priorities left, at which point the list of attempted priorities will be reset, essentially starting from the beginning. For example, given three priorities P0, P1, P2 with healthy % of 100, 0 and 50 respectively, the following sequence of priorities would be selected (assuming update_frequency = 1): Attempt 1: P0 (P0 is 100% healthy) Attempt 2: P2 (P0 already attempted, P2 only healthy priority) Attempt 3: P0 (no healthy priorities, reset) Attempt 4: P2

In the case of all upstream hosts being unhealthy, no adjustments will be made to the original priority load, so behavior should be identical to not using this plugin.

Using this PriorityFilter requires rebuilding the priority load, which runs in O(# of priorities), which might incur significant overhead for clusters with many priorities. [#extension: envoy.retry_priorities.previous_priorities]

func (*PreviousPrioritiesConfig) Descriptor

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

Deprecated: Use PreviousPrioritiesConfig.ProtoReflect.Descriptor instead.

func (*PreviousPrioritiesConfig) GetUpdateFrequency

func (x *PreviousPrioritiesConfig) GetUpdateFrequency() int32

func (*PreviousPrioritiesConfig) ProtoMessage

func (*PreviousPrioritiesConfig) ProtoMessage()

func (*PreviousPrioritiesConfig) ProtoReflect

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

func (*PreviousPrioritiesConfig) Reset

func (x *PreviousPrioritiesConfig) Reset()

func (*PreviousPrioritiesConfig) String

func (x *PreviousPrioritiesConfig) String() string

func (*PreviousPrioritiesConfig) Validate

func (m *PreviousPrioritiesConfig) Validate() error

Validate checks the field values on PreviousPrioritiesConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PreviousPrioritiesConfig) ValidateAll

func (m *PreviousPrioritiesConfig) ValidateAll() error

ValidateAll checks the field values on PreviousPrioritiesConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PreviousPrioritiesConfigMultiError, or nil if none found.

type PreviousPrioritiesConfigMultiError

type PreviousPrioritiesConfigMultiError []error

PreviousPrioritiesConfigMultiError is an error wrapping multiple validation errors returned by PreviousPrioritiesConfig.ValidateAll() if the designated constraints aren't met.

func (PreviousPrioritiesConfigMultiError) AllErrors

func (m PreviousPrioritiesConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PreviousPrioritiesConfigMultiError) Error

func (m PreviousPrioritiesConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PreviousPrioritiesConfigValidationError

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

PreviousPrioritiesConfigValidationError is the validation error returned by PreviousPrioritiesConfig.Validate if the designated constraints aren't met.

func (PreviousPrioritiesConfigValidationError) Cause

func (e PreviousPrioritiesConfigValidationError) Cause() error

Cause function returns cause value.

func (PreviousPrioritiesConfigValidationError) Error

func (e PreviousPrioritiesConfigValidationError) Error() string

Error satisfies the builtin error interface

func (PreviousPrioritiesConfigValidationError) ErrorName

func (e PreviousPrioritiesConfigValidationError) ErrorName() string

ErrorName returns error name.

func (PreviousPrioritiesConfigValidationError) Field

func (e PreviousPrioritiesConfigValidationError) Field() string

Field function returns field value.

func (PreviousPrioritiesConfigValidationError) Key

func (e PreviousPrioritiesConfigValidationError) Key() bool

Key function returns key value.

func (PreviousPrioritiesConfigValidationError) Reason

func (e PreviousPrioritiesConfigValidationError) Reason() string

Reason function returns reason value.