envoy_config_overload_v3

package
v2.0.4-rc.0 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2021 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ScaleTimersOverloadActionConfig_TimerType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "HTTP_DOWNSTREAM_CONNECTION_IDLE",
		2: "HTTP_DOWNSTREAM_STREAM_IDLE",
	}
	ScaleTimersOverloadActionConfig_TimerType_value = map[string]int32{
		"UNSPECIFIED":                     0,
		"HTTP_DOWNSTREAM_CONNECTION_IDLE": 1,
		"HTTP_DOWNSTREAM_STREAM_IDLE":     2,
	}
)

Enum value maps for ScaleTimersOverloadActionConfig_TimerType.

View Source
var File_envoy_config_overload_v3_overload_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type OverloadAction

type OverloadAction struct {

	// The name of the overload action. This is just a well-known string that listeners can
	// use for registering callbacks. Custom overload actions should be named using reverse
	// DNS to ensure uniqueness.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A set of triggers for this action. The state of the action is the maximum
	// state of all triggers, which can be scaling between 0 and 1 or saturated. Listeners
	// are notified when the overload action changes state.
	Triggers []*Trigger `protobuf:"bytes,2,rep,name=triggers,proto3" json:"triggers,omitempty"`
	// Configuration for the action being instantiated.
	TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"`
	// contains filtered or unexported fields
}

func (*OverloadAction) Descriptor deprecated

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

Deprecated: Use OverloadAction.ProtoReflect.Descriptor instead.

func (*OverloadAction) GetName

func (x *OverloadAction) GetName() string

func (*OverloadAction) GetTriggers

func (x *OverloadAction) GetTriggers() []*Trigger

func (*OverloadAction) GetTypedConfig

func (x *OverloadAction) GetTypedConfig() *any.Any

func (*OverloadAction) ProtoMessage

func (*OverloadAction) ProtoMessage()

func (*OverloadAction) ProtoReflect

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

func (*OverloadAction) Reset

func (x *OverloadAction) Reset()

func (*OverloadAction) String

func (x *OverloadAction) String() string

func (*OverloadAction) Validate

func (m *OverloadAction) Validate() error

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

type OverloadActionValidationError

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

OverloadActionValidationError is the validation error returned by OverloadAction.Validate if the designated constraints aren't met.

func (OverloadActionValidationError) Cause

Cause function returns cause value.

func (OverloadActionValidationError) Error

Error satisfies the builtin error interface

func (OverloadActionValidationError) ErrorName

func (e OverloadActionValidationError) ErrorName() string

ErrorName returns error name.

func (OverloadActionValidationError) Field

Field function returns field value.

func (OverloadActionValidationError) Key

Key function returns key value.

func (OverloadActionValidationError) Reason

Reason function returns reason value.

type OverloadManager

type OverloadManager struct {

	// The interval for refreshing resource usage.
	RefreshInterval *duration.Duration `protobuf:"bytes,1,opt,name=refresh_interval,json=refreshInterval,proto3" json:"refresh_interval,omitempty"`
	// The set of resources to monitor.
	ResourceMonitors []*ResourceMonitor `protobuf:"bytes,2,rep,name=resource_monitors,json=resourceMonitors,proto3" json:"resource_monitors,omitempty"`
	// The set of overload actions.
	Actions []*OverloadAction `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

func (*OverloadManager) Descriptor deprecated

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

Deprecated: Use OverloadManager.ProtoReflect.Descriptor instead.

func (*OverloadManager) GetActions

func (x *OverloadManager) GetActions() []*OverloadAction

func (*OverloadManager) GetRefreshInterval

func (x *OverloadManager) GetRefreshInterval() *duration.Duration

func (*OverloadManager) GetResourceMonitors

func (x *OverloadManager) GetResourceMonitors() []*ResourceMonitor

func (*OverloadManager) ProtoMessage

func (*OverloadManager) ProtoMessage()

func (*OverloadManager) ProtoReflect

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

func (*OverloadManager) Reset

func (x *OverloadManager) Reset()

func (*OverloadManager) String

func (x *OverloadManager) String() string

func (*OverloadManager) Validate

func (m *OverloadManager) Validate() error

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

type OverloadManagerValidationError

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

OverloadManagerValidationError is the validation error returned by OverloadManager.Validate if the designated constraints aren't met.

func (OverloadManagerValidationError) Cause

Cause function returns cause value.

func (OverloadManagerValidationError) Error

Error satisfies the builtin error interface

func (OverloadManagerValidationError) ErrorName

func (e OverloadManagerValidationError) ErrorName() string

ErrorName returns error name.

func (OverloadManagerValidationError) Field

Field function returns field value.

func (OverloadManagerValidationError) Key

Key function returns key value.

func (OverloadManagerValidationError) Reason

Reason function returns reason value.

type ResourceMonitor

type ResourceMonitor struct {

	// The name of the resource monitor to instantiate. Must match a registered
	// resource monitor type. The built-in resource monitors are:
	//
	// * :ref:`envoy.resource_monitors.fixed_heap
	//   <envoy_api_msg_config.resource_monitor.fixed_heap.v2alpha.FixedHeapConfig>`
	// * :ref:`envoy.resource_monitors.injected_resource
	//   <envoy_api_msg_config.resource_monitor.injected_resource.v2alpha.InjectedResourceConfig>`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Configuration for the resource monitor being instantiated.
	//
	// Types that are assignable to ConfigType:
	//	*ResourceMonitor_TypedConfig
	//	*ResourceMonitor_HiddenEnvoyDeprecatedConfig
	ConfigType isResourceMonitor_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*ResourceMonitor) Descriptor deprecated

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

Deprecated: Use ResourceMonitor.ProtoReflect.Descriptor instead.

func (*ResourceMonitor) GetConfigType

func (m *ResourceMonitor) GetConfigType() isResourceMonitor_ConfigType

func (*ResourceMonitor) GetHiddenEnvoyDeprecatedConfig deprecated

func (x *ResourceMonitor) GetHiddenEnvoyDeprecatedConfig() *_struct.Struct

Deprecated: Do not use.

func (*ResourceMonitor) GetName

func (x *ResourceMonitor) GetName() string

func (*ResourceMonitor) GetTypedConfig

func (x *ResourceMonitor) GetTypedConfig() *any.Any

func (*ResourceMonitor) ProtoMessage

func (*ResourceMonitor) ProtoMessage()

func (*ResourceMonitor) ProtoReflect

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

func (*ResourceMonitor) Reset

func (x *ResourceMonitor) Reset()

func (*ResourceMonitor) String

func (x *ResourceMonitor) String() string

func (*ResourceMonitor) Validate

func (m *ResourceMonitor) Validate() error

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

type ResourceMonitorValidationError

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

ResourceMonitorValidationError is the validation error returned by ResourceMonitor.Validate if the designated constraints aren't met.

func (ResourceMonitorValidationError) Cause

Cause function returns cause value.

func (ResourceMonitorValidationError) Error

Error satisfies the builtin error interface

func (ResourceMonitorValidationError) ErrorName

func (e ResourceMonitorValidationError) ErrorName() string

ErrorName returns error name.

func (ResourceMonitorValidationError) Field

Field function returns field value.

func (ResourceMonitorValidationError) Key

Key function returns key value.

func (ResourceMonitorValidationError) Reason

Reason function returns reason value.

type ResourceMonitor_HiddenEnvoyDeprecatedConfig

type ResourceMonitor_HiddenEnvoyDeprecatedConfig struct {
	// Deprecated: Do not use.
	HiddenEnvoyDeprecatedConfig *_struct.Struct `protobuf:"bytes,2,opt,name=hidden_envoy_deprecated_config,json=hiddenEnvoyDeprecatedConfig,proto3,oneof"`
}

type ResourceMonitor_TypedConfig

type ResourceMonitor_TypedConfig struct {
	TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type ScaleTimersOverloadActionConfig

type ScaleTimersOverloadActionConfig struct {

	// A set of timer scaling rules to be applied.
	TimerScaleFactors []*ScaleTimersOverloadActionConfig_ScaleTimer `protobuf:"bytes,1,rep,name=timer_scale_factors,json=timerScaleFactors,proto3" json:"timer_scale_factors,omitempty"`
	// contains filtered or unexported fields
}

Typed configuration for the "envoy.overload_actions.reduce_timeouts" action. See :ref:`the docs <config_overload_manager_reducing_timeouts>` for an example of how to configure the action with different timeouts and minimum values.

func (*ScaleTimersOverloadActionConfig) Descriptor deprecated

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

Deprecated: Use ScaleTimersOverloadActionConfig.ProtoReflect.Descriptor instead.

func (*ScaleTimersOverloadActionConfig) GetTimerScaleFactors

func (*ScaleTimersOverloadActionConfig) ProtoMessage

func (*ScaleTimersOverloadActionConfig) ProtoMessage()

func (*ScaleTimersOverloadActionConfig) ProtoReflect

func (*ScaleTimersOverloadActionConfig) Reset

func (*ScaleTimersOverloadActionConfig) String

func (*ScaleTimersOverloadActionConfig) Validate

func (m *ScaleTimersOverloadActionConfig) Validate() error

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

type ScaleTimersOverloadActionConfigValidationError

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

ScaleTimersOverloadActionConfigValidationError is the validation error returned by ScaleTimersOverloadActionConfig.Validate if the designated constraints aren't met.

func (ScaleTimersOverloadActionConfigValidationError) Cause

Cause function returns cause value.

func (ScaleTimersOverloadActionConfigValidationError) Error

Error satisfies the builtin error interface

func (ScaleTimersOverloadActionConfigValidationError) ErrorName

ErrorName returns error name.

func (ScaleTimersOverloadActionConfigValidationError) Field

Field function returns field value.

func (ScaleTimersOverloadActionConfigValidationError) Key

Key function returns key value.

func (ScaleTimersOverloadActionConfigValidationError) Reason

Reason function returns reason value.

type ScaleTimersOverloadActionConfig_ScaleTimer

type ScaleTimersOverloadActionConfig_ScaleTimer struct {

	// The type of timer this minimum applies to.
	Timer ScaleTimersOverloadActionConfig_TimerType `` /* 136-byte string literal not displayed */
	// Types that are assignable to OverloadAdjust:
	//	*ScaleTimersOverloadActionConfig_ScaleTimer_MinTimeout
	//	*ScaleTimersOverloadActionConfig_ScaleTimer_MinScale
	OverloadAdjust isScaleTimersOverloadActionConfig_ScaleTimer_OverloadAdjust `protobuf_oneof:"overload_adjust"`
	// contains filtered or unexported fields
}

func (*ScaleTimersOverloadActionConfig_ScaleTimer) Descriptor deprecated

Deprecated: Use ScaleTimersOverloadActionConfig_ScaleTimer.ProtoReflect.Descriptor instead.

func (*ScaleTimersOverloadActionConfig_ScaleTimer) GetMinScale

func (*ScaleTimersOverloadActionConfig_ScaleTimer) GetMinTimeout

func (*ScaleTimersOverloadActionConfig_ScaleTimer) GetOverloadAdjust

func (m *ScaleTimersOverloadActionConfig_ScaleTimer) GetOverloadAdjust() isScaleTimersOverloadActionConfig_ScaleTimer_OverloadAdjust

func (*ScaleTimersOverloadActionConfig_ScaleTimer) GetTimer

func (*ScaleTimersOverloadActionConfig_ScaleTimer) ProtoMessage

func (*ScaleTimersOverloadActionConfig_ScaleTimer) ProtoReflect

func (*ScaleTimersOverloadActionConfig_ScaleTimer) Reset

func (*ScaleTimersOverloadActionConfig_ScaleTimer) String

func (*ScaleTimersOverloadActionConfig_ScaleTimer) Validate

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

type ScaleTimersOverloadActionConfig_ScaleTimerValidationError

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

ScaleTimersOverloadActionConfig_ScaleTimerValidationError is the validation error returned by ScaleTimersOverloadActionConfig_ScaleTimer.Validate if the designated constraints aren't met.

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Cause

Cause function returns cause value.

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Error

Error satisfies the builtin error interface

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) ErrorName

ErrorName returns error name.

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Field

Field function returns field value.

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Key

Key function returns key value.

func (ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Reason

Reason function returns reason value.

type ScaleTimersOverloadActionConfig_ScaleTimer_MinScale

type ScaleTimersOverloadActionConfig_ScaleTimer_MinScale struct {
	// Sets the minimum duration as a percentage of the maximum value.
	MinScale *v3.Percent `protobuf:"bytes,3,opt,name=min_scale,json=minScale,proto3,oneof"`
}

type ScaleTimersOverloadActionConfig_ScaleTimer_MinTimeout

type ScaleTimersOverloadActionConfig_ScaleTimer_MinTimeout struct {
	// Sets the minimum duration as an absolute value.
	MinTimeout *duration.Duration `protobuf:"bytes,2,opt,name=min_timeout,json=minTimeout,proto3,oneof"`
}

type ScaleTimersOverloadActionConfig_TimerType

type ScaleTimersOverloadActionConfig_TimerType int32
const (
	// Unsupported value; users must explicitly specify the timer they want scaled.
	ScaleTimersOverloadActionConfig_UNSPECIFIED ScaleTimersOverloadActionConfig_TimerType = 0
	// Adjusts the idle timer for downstream HTTP connections that takes effect when there are no active streams.
	// This affects the value of :ref:`HttpConnectionManager.common_http_protocol_options.idle_timeout
	// <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.idle_timeout>`
	ScaleTimersOverloadActionConfig_HTTP_DOWNSTREAM_CONNECTION_IDLE ScaleTimersOverloadActionConfig_TimerType = 1
	// Adjusts the idle timer for HTTP streams initiated by downstream clients.
	// This affects the value of :ref:`RouteAction.idle_timeout <envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout>` and
	// :ref:`HttpConnectionManager.stream_idle_timeout
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>`
	ScaleTimersOverloadActionConfig_HTTP_DOWNSTREAM_STREAM_IDLE ScaleTimersOverloadActionConfig_TimerType = 2
)

func (ScaleTimersOverloadActionConfig_TimerType) Descriptor

func (ScaleTimersOverloadActionConfig_TimerType) Enum

func (ScaleTimersOverloadActionConfig_TimerType) EnumDescriptor deprecated

func (ScaleTimersOverloadActionConfig_TimerType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ScaleTimersOverloadActionConfig_TimerType.Descriptor instead.

func (ScaleTimersOverloadActionConfig_TimerType) Number

func (ScaleTimersOverloadActionConfig_TimerType) String

func (ScaleTimersOverloadActionConfig_TimerType) Type

type ScaledTrigger

type ScaledTrigger struct {

	// If the resource pressure is greater than this value, the trigger will be in the
	// :ref:`scaling <arch_overview_overload_manager-triggers-state>` state with value
	// `(pressure - scaling_threshold) / (saturation_threshold - scaling_threshold)`.
	ScalingThreshold float64 `protobuf:"fixed64,1,opt,name=scaling_threshold,json=scalingThreshold,proto3" json:"scaling_threshold,omitempty"`
	// If the resource pressure is greater than this value, the trigger will enter saturation.
	SaturationThreshold float64 `protobuf:"fixed64,2,opt,name=saturation_threshold,json=saturationThreshold,proto3" json:"saturation_threshold,omitempty"`
	// contains filtered or unexported fields
}

func (*ScaledTrigger) Descriptor deprecated

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

Deprecated: Use ScaledTrigger.ProtoReflect.Descriptor instead.

func (*ScaledTrigger) GetSaturationThreshold

func (x *ScaledTrigger) GetSaturationThreshold() float64

func (*ScaledTrigger) GetScalingThreshold

func (x *ScaledTrigger) GetScalingThreshold() float64

func (*ScaledTrigger) ProtoMessage

func (*ScaledTrigger) ProtoMessage()

func (*ScaledTrigger) ProtoReflect

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

func (*ScaledTrigger) Reset

func (x *ScaledTrigger) Reset()

func (*ScaledTrigger) String

func (x *ScaledTrigger) String() string

func (*ScaledTrigger) Validate

func (m *ScaledTrigger) Validate() error

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

type ScaledTriggerValidationError

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

ScaledTriggerValidationError is the validation error returned by ScaledTrigger.Validate if the designated constraints aren't met.

func (ScaledTriggerValidationError) Cause

Cause function returns cause value.

func (ScaledTriggerValidationError) Error

Error satisfies the builtin error interface

func (ScaledTriggerValidationError) ErrorName

func (e ScaledTriggerValidationError) ErrorName() string

ErrorName returns error name.

func (ScaledTriggerValidationError) Field

Field function returns field value.

func (ScaledTriggerValidationError) Key

Key function returns key value.

func (ScaledTriggerValidationError) Reason

Reason function returns reason value.

type ThresholdTrigger

type ThresholdTrigger struct {

	// If the resource pressure is greater than or equal to this value, the trigger
	// will enter saturation.
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ThresholdTrigger) Descriptor deprecated

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

Deprecated: Use ThresholdTrigger.ProtoReflect.Descriptor instead.

func (*ThresholdTrigger) GetValue

func (x *ThresholdTrigger) GetValue() float64

func (*ThresholdTrigger) ProtoMessage

func (*ThresholdTrigger) ProtoMessage()

func (*ThresholdTrigger) ProtoReflect

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

func (*ThresholdTrigger) Reset

func (x *ThresholdTrigger) Reset()

func (*ThresholdTrigger) String

func (x *ThresholdTrigger) String() string

func (*ThresholdTrigger) Validate

func (m *ThresholdTrigger) Validate() error

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

type ThresholdTriggerValidationError

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

ThresholdTriggerValidationError is the validation error returned by ThresholdTrigger.Validate if the designated constraints aren't met.

func (ThresholdTriggerValidationError) Cause

Cause function returns cause value.

func (ThresholdTriggerValidationError) Error

Error satisfies the builtin error interface

func (ThresholdTriggerValidationError) ErrorName

ErrorName returns error name.

func (ThresholdTriggerValidationError) Field

Field function returns field value.

func (ThresholdTriggerValidationError) Key

Key function returns key value.

func (ThresholdTriggerValidationError) Reason

Reason function returns reason value.

type Trigger

type Trigger struct {

	// The name of the resource this is a trigger for.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to TriggerOneof:
	//	*Trigger_Threshold
	//	*Trigger_Scaled
	TriggerOneof isTrigger_TriggerOneof `protobuf_oneof:"trigger_oneof"`
	// contains filtered or unexported fields
}

func (*Trigger) Descriptor deprecated

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

Deprecated: Use Trigger.ProtoReflect.Descriptor instead.

func (*Trigger) GetName

func (x *Trigger) GetName() string

func (*Trigger) GetScaled

func (x *Trigger) GetScaled() *ScaledTrigger

func (*Trigger) GetThreshold

func (x *Trigger) GetThreshold() *ThresholdTrigger

func (*Trigger) GetTriggerOneof

func (m *Trigger) GetTriggerOneof() isTrigger_TriggerOneof

func (*Trigger) ProtoMessage

func (*Trigger) ProtoMessage()

func (*Trigger) ProtoReflect

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

func (*Trigger) Reset

func (x *Trigger) Reset()

func (*Trigger) String

func (x *Trigger) String() string

func (*Trigger) Validate

func (m *Trigger) Validate() error

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

type TriggerValidationError

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

TriggerValidationError is the validation error returned by Trigger.Validate if the designated constraints aren't met.

func (TriggerValidationError) Cause

func (e TriggerValidationError) Cause() error

Cause function returns cause value.

func (TriggerValidationError) Error

func (e TriggerValidationError) Error() string

Error satisfies the builtin error interface

func (TriggerValidationError) ErrorName

func (e TriggerValidationError) ErrorName() string

ErrorName returns error name.

func (TriggerValidationError) Field

func (e TriggerValidationError) Field() string

Field function returns field value.

func (TriggerValidationError) Key

func (e TriggerValidationError) Key() bool

Key function returns key value.

func (TriggerValidationError) Reason

func (e TriggerValidationError) Reason() string

Reason function returns reason value.

type Trigger_Scaled

type Trigger_Scaled struct {
	Scaled *ScaledTrigger `protobuf:"bytes,3,opt,name=scaled,proto3,oneof"`
}

type Trigger_Threshold

type Trigger_Threshold struct {
	Threshold *ThresholdTrigger `protobuf:"bytes,2,opt,name=threshold,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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