ratelimitv3

package
v0.0.0-...-f2c5ffe Latest Latest
Warning

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

Go to latest
Published: Dec 13, 2024 License: Apache-2.0 Imports: 20 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	XRateLimitHeadersRFCVersion_name = map[int32]string{
		0: "OFF",
		1: "DRAFT_VERSION_03",
	}
	XRateLimitHeadersRFCVersion_value = map[string]int32{
		"OFF":              0,
		"DRAFT_VERSION_03": 1,
	}
)

Enum value maps for XRateLimitHeadersRFCVersion.

View Source
var (
	VhRateLimitsOptions_name = map[int32]string{
		0: "OVERRIDE",
		1: "INCLUDE",
		2: "IGNORE",
	}
	VhRateLimitsOptions_value = map[string]int32{
		"OVERRIDE": 0,
		"INCLUDE":  1,
		"IGNORE":   2,
	}
)

Enum value maps for VhRateLimitsOptions.

View Source
var File_envoy_extensions_common_ratelimit_v3_ratelimit_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type LocalClusterRateLimit

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

Configuration used to enable local cluster level rate limiting where the token buckets will be shared across all the Envoy instances in the local cluster. A share will be calculated based on the membership of the local cluster dynamically and the configuration. When the limiter refilling the token bucket, the share will be applied. By default, the token bucket will be shared evenly.

See :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` for more context about local cluster.

func (*LocalClusterRateLimit) Descriptor deprecated

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

Deprecated: Use LocalClusterRateLimit.ProtoReflect.Descriptor instead.

func (*LocalClusterRateLimit) ProtoMessage

func (*LocalClusterRateLimit) ProtoMessage()

func (*LocalClusterRateLimit) ProtoReflect

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

func (*LocalClusterRateLimit) Reset

func (x *LocalClusterRateLimit) Reset()

func (*LocalClusterRateLimit) String

func (x *LocalClusterRateLimit) String() string

func (*LocalClusterRateLimit) Validate

func (m *LocalClusterRateLimit) Validate() error

Validate checks the field values on LocalClusterRateLimit 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 (*LocalClusterRateLimit) ValidateAll

func (m *LocalClusterRateLimit) ValidateAll() error

ValidateAll checks the field values on LocalClusterRateLimit 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 LocalClusterRateLimitMultiError, or nil if none found.

type LocalClusterRateLimitMultiError

type LocalClusterRateLimitMultiError []error

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

func (LocalClusterRateLimitMultiError) AllErrors

func (m LocalClusterRateLimitMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (LocalClusterRateLimitMultiError) Error

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

type LocalClusterRateLimitValidationError

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

LocalClusterRateLimitValidationError is the validation error returned by LocalClusterRateLimit.Validate if the designated constraints aren't met.

func (LocalClusterRateLimitValidationError) Cause

Cause function returns cause value.

func (LocalClusterRateLimitValidationError) Error

Error satisfies the builtin error interface

func (LocalClusterRateLimitValidationError) ErrorName

ErrorName returns error name.

func (LocalClusterRateLimitValidationError) Field

Field function returns field value.

func (LocalClusterRateLimitValidationError) Key

Key function returns key value.

func (LocalClusterRateLimitValidationError) Reason

Reason function returns reason value.

type LocalRateLimitDescriptor

type LocalRateLimitDescriptor struct {

	// Descriptor entries.
	Entries []*RateLimitDescriptor_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// Token Bucket algorithm for local ratelimiting.
	TokenBucket *v3.TokenBucket `protobuf:"bytes,2,opt,name=token_bucket,json=tokenBucket,proto3" json:"token_bucket,omitempty"`
	// contains filtered or unexported fields
}

func (*LocalRateLimitDescriptor) Descriptor deprecated

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

Deprecated: Use LocalRateLimitDescriptor.ProtoReflect.Descriptor instead.

func (*LocalRateLimitDescriptor) GetEntries

func (*LocalRateLimitDescriptor) GetTokenBucket

func (x *LocalRateLimitDescriptor) GetTokenBucket() *v3.TokenBucket

func (*LocalRateLimitDescriptor) ProtoMessage

func (*LocalRateLimitDescriptor) ProtoMessage()

func (*LocalRateLimitDescriptor) ProtoReflect

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

func (*LocalRateLimitDescriptor) Reset

func (x *LocalRateLimitDescriptor) Reset()

func (*LocalRateLimitDescriptor) String

func (x *LocalRateLimitDescriptor) String() string

func (*LocalRateLimitDescriptor) Validate

func (m *LocalRateLimitDescriptor) Validate() error

Validate checks the field values on LocalRateLimitDescriptor 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 (*LocalRateLimitDescriptor) ValidateAll

func (m *LocalRateLimitDescriptor) ValidateAll() error

ValidateAll checks the field values on LocalRateLimitDescriptor 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 LocalRateLimitDescriptorMultiError, or nil if none found.

type LocalRateLimitDescriptorMultiError

type LocalRateLimitDescriptorMultiError []error

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

func (LocalRateLimitDescriptorMultiError) AllErrors

func (m LocalRateLimitDescriptorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (LocalRateLimitDescriptorMultiError) Error

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

type LocalRateLimitDescriptorValidationError

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

LocalRateLimitDescriptorValidationError is the validation error returned by LocalRateLimitDescriptor.Validate if the designated constraints aren't met.

func (LocalRateLimitDescriptorValidationError) Cause

Cause function returns cause value.

func (LocalRateLimitDescriptorValidationError) Error

Error satisfies the builtin error interface

func (LocalRateLimitDescriptorValidationError) ErrorName

ErrorName returns error name.

func (LocalRateLimitDescriptorValidationError) Field

Field function returns field value.

func (LocalRateLimitDescriptorValidationError) Key

Key function returns key value.

func (LocalRateLimitDescriptorValidationError) Reason

Reason function returns reason value.

type RateLimitDescriptor

type RateLimitDescriptor struct {

	// Descriptor entries.
	Entries []*RateLimitDescriptor_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// Optional rate limit override to supply to the ratelimit service.
	Limit *RateLimitDescriptor_RateLimitOverride `protobuf:"bytes,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

A RateLimitDescriptor is a list of hierarchical entries that are used by the service to determine the final rate limit key and overall allowed limit. Here are some examples of how they might be used for the domain "envoy".

.. code-block:: cpp

["authenticated": "false"], ["remote_address": "10.0.0.1"]

What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The configuration supplies a default limit for the *remote_address* key. If there is a desire to raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the configuration.

.. code-block:: cpp

["authenticated": "false"], ["path": "/foo/bar"]

What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if configured that way in the service).

.. code-block:: cpp

["authenticated": "false"], ["path": "/foo/bar"], ["remote_address": "10.0.0.1"]

What it does: Limits unauthenticated traffic to a specific path for a specific IP address. Like (1) we can raise/block specific IP addresses if we want with an override configuration.

.. code-block:: cpp

["authenticated": "true"], ["client_id": "foo"]

What it does: Limits all traffic for an authenticated client "foo"

.. code-block:: cpp

["authenticated": "true"], ["client_id": "foo"], ["path": "/foo/bar"]

What it does: Limits traffic to a specific path for an authenticated client "foo"

The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired. This enables building complex application scenarios with a generic backend.

Optionally the descriptor can contain a limit override under a "limit" key, that specifies the number of requests per unit to use instead of the number configured in the rate limiting service.

func (*RateLimitDescriptor) Descriptor deprecated

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

Deprecated: Use RateLimitDescriptor.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor) GetEntries

func (*RateLimitDescriptor) GetLimit

func (*RateLimitDescriptor) ProtoMessage

func (*RateLimitDescriptor) ProtoMessage()

func (*RateLimitDescriptor) ProtoReflect

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

func (*RateLimitDescriptor) Reset

func (x *RateLimitDescriptor) Reset()

func (*RateLimitDescriptor) String

func (x *RateLimitDescriptor) String() string

func (*RateLimitDescriptor) Validate

func (m *RateLimitDescriptor) Validate() error

Validate checks the field values on RateLimitDescriptor 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 (*RateLimitDescriptor) ValidateAll

func (m *RateLimitDescriptor) ValidateAll() error

ValidateAll checks the field values on RateLimitDescriptor 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 RateLimitDescriptorMultiError, or nil if none found.

type RateLimitDescriptorMultiError

type RateLimitDescriptorMultiError []error

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

func (RateLimitDescriptorMultiError) AllErrors

func (m RateLimitDescriptorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitDescriptorMultiError) Error

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

type RateLimitDescriptorValidationError

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

RateLimitDescriptorValidationError is the validation error returned by RateLimitDescriptor.Validate if the designated constraints aren't met.

func (RateLimitDescriptorValidationError) Cause

Cause function returns cause value.

func (RateLimitDescriptorValidationError) Error

Error satisfies the builtin error interface

func (RateLimitDescriptorValidationError) ErrorName

ErrorName returns error name.

func (RateLimitDescriptorValidationError) Field

Field function returns field value.

func (RateLimitDescriptorValidationError) Key

Key function returns key value.

func (RateLimitDescriptorValidationError) Reason

Reason function returns reason value.

type RateLimitDescriptor_Entry

type RateLimitDescriptor_Entry struct {

	// Descriptor key.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Descriptor value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*RateLimitDescriptor_Entry) Descriptor deprecated

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

Deprecated: Use RateLimitDescriptor_Entry.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor_Entry) GetKey

func (x *RateLimitDescriptor_Entry) GetKey() string

func (*RateLimitDescriptor_Entry) GetValue

func (x *RateLimitDescriptor_Entry) GetValue() string

func (*RateLimitDescriptor_Entry) ProtoMessage

func (*RateLimitDescriptor_Entry) ProtoMessage()

func (*RateLimitDescriptor_Entry) ProtoReflect

func (*RateLimitDescriptor_Entry) Reset

func (x *RateLimitDescriptor_Entry) Reset()

func (*RateLimitDescriptor_Entry) String

func (x *RateLimitDescriptor_Entry) String() string

func (*RateLimitDescriptor_Entry) Validate

func (m *RateLimitDescriptor_Entry) Validate() error

Validate checks the field values on RateLimitDescriptor_Entry 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 (*RateLimitDescriptor_Entry) ValidateAll

func (m *RateLimitDescriptor_Entry) ValidateAll() error

ValidateAll checks the field values on RateLimitDescriptor_Entry 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 RateLimitDescriptor_EntryMultiError, or nil if none found.

type RateLimitDescriptor_EntryMultiError

type RateLimitDescriptor_EntryMultiError []error

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

func (RateLimitDescriptor_EntryMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (RateLimitDescriptor_EntryMultiError) Error

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

type RateLimitDescriptor_EntryValidationError

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

RateLimitDescriptor_EntryValidationError is the validation error returned by RateLimitDescriptor_Entry.Validate if the designated constraints aren't met.

func (RateLimitDescriptor_EntryValidationError) Cause

Cause function returns cause value.

func (RateLimitDescriptor_EntryValidationError) Error

Error satisfies the builtin error interface

func (RateLimitDescriptor_EntryValidationError) ErrorName

ErrorName returns error name.

func (RateLimitDescriptor_EntryValidationError) Field

Field function returns field value.

func (RateLimitDescriptor_EntryValidationError) Key

Key function returns key value.

func (RateLimitDescriptor_EntryValidationError) Reason

Reason function returns reason value.

type RateLimitDescriptor_RateLimitOverride

type RateLimitDescriptor_RateLimitOverride struct {

	// The number of requests per unit of time.
	RequestsPerUnit uint32 `protobuf:"varint,1,opt,name=requests_per_unit,json=requestsPerUnit,proto3" json:"requests_per_unit,omitempty"`
	// The unit of time.
	Unit v3.RateLimitUnit `protobuf:"varint,2,opt,name=unit,proto3,enum=envoy.type.v3.RateLimitUnit" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

Override rate limit to apply to this descriptor instead of the limit configured in the rate limit service. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.

func (*RateLimitDescriptor_RateLimitOverride) Descriptor deprecated

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

Deprecated: Use RateLimitDescriptor_RateLimitOverride.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit

func (x *RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit() uint32

func (*RateLimitDescriptor_RateLimitOverride) GetUnit

func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage

func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage()

func (*RateLimitDescriptor_RateLimitOverride) ProtoReflect

func (*RateLimitDescriptor_RateLimitOverride) Reset

func (*RateLimitDescriptor_RateLimitOverride) String

func (*RateLimitDescriptor_RateLimitOverride) Validate

Validate checks the field values on RateLimitDescriptor_RateLimitOverride 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 (*RateLimitDescriptor_RateLimitOverride) ValidateAll

ValidateAll checks the field values on RateLimitDescriptor_RateLimitOverride 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 RateLimitDescriptor_RateLimitOverrideMultiError, or nil if none found.

type RateLimitDescriptor_RateLimitOverrideMultiError

type RateLimitDescriptor_RateLimitOverrideMultiError []error

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

func (RateLimitDescriptor_RateLimitOverrideMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (RateLimitDescriptor_RateLimitOverrideMultiError) Error

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

type RateLimitDescriptor_RateLimitOverrideValidationError

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

RateLimitDescriptor_RateLimitOverrideValidationError is the validation error returned by RateLimitDescriptor_RateLimitOverride.Validate if the designated constraints aren't met.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Cause

Cause function returns cause value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Error

Error satisfies the builtin error interface

func (RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName

ErrorName returns error name.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Field

Field function returns field value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Key

Key function returns key value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Reason

Reason function returns reason value.

type VhRateLimitsOptions

type VhRateLimitsOptions int32
const (
	// Use the virtual host rate limits unless the route has a rate limit policy.
	VhRateLimitsOptions_OVERRIDE VhRateLimitsOptions = 0
	// Use the virtual host rate limits even if the route has a rate limit policy.
	VhRateLimitsOptions_INCLUDE VhRateLimitsOptions = 1
	// Ignore the virtual host rate limits even if the route does not have a rate limit policy.
	VhRateLimitsOptions_IGNORE VhRateLimitsOptions = 2
)

func (VhRateLimitsOptions) Descriptor

func (VhRateLimitsOptions) Enum

func (VhRateLimitsOptions) EnumDescriptor deprecated

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

Deprecated: Use VhRateLimitsOptions.Descriptor instead.

func (VhRateLimitsOptions) Number

func (VhRateLimitsOptions) String

func (x VhRateLimitsOptions) String() string

func (VhRateLimitsOptions) Type

type XRateLimitHeadersRFCVersion

type XRateLimitHeadersRFCVersion int32

Defines the version of the standard to use for X-RateLimit headers.

const (
	// X-RateLimit headers disabled.
	XRateLimitHeadersRFCVersion_OFF XRateLimitHeadersRFCVersion = 0
	// Use `draft RFC Version 03 <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_ where 3 headers will be added:
	//
	//   - “X-RateLimit-Limit“ - indicates the request-quota associated to the
	//     client in the current time-window followed by the description of the
	//     quota policy. The value is returned by the maximum tokens of the token bucket.
	//   - “X-RateLimit-Remaining“ - indicates the remaining requests in the
	//     current time-window. The value is returned by the remaining tokens in the token bucket.
	//   - “X-RateLimit-Reset“ - indicates the number of seconds until reset of
	//     the current time-window. The value is returned by the remaining fill interval of the token bucket.
	XRateLimitHeadersRFCVersion_DRAFT_VERSION_03 XRateLimitHeadersRFCVersion = 1
)

func (XRateLimitHeadersRFCVersion) Descriptor

func (XRateLimitHeadersRFCVersion) Enum

func (XRateLimitHeadersRFCVersion) EnumDescriptor deprecated

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

Deprecated: Use XRateLimitHeadersRFCVersion.Descriptor instead.

func (XRateLimitHeadersRFCVersion) Number

func (XRateLimitHeadersRFCVersion) String

func (XRateLimitHeadersRFCVersion) Type

Jump to

Keyboard shortcuts

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