envoy_extensions_filters_network_redis_proxy_v3

package
v2.5.1 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	RedisProxy_ConnPoolSettings_ReadPolicy_name = map[int32]string{
		0: "MASTER",
		1: "PREFER_MASTER",
		2: "REPLICA",
		3: "PREFER_REPLICA",
		4: "ANY",
	}
	RedisProxy_ConnPoolSettings_ReadPolicy_value = map[string]int32{
		"MASTER":         0,
		"PREFER_MASTER":  1,
		"REPLICA":        2,
		"PREFER_REPLICA": 3,
		"ANY":            4,
	}
)

Enum value maps for RedisProxy_ConnPoolSettings_ReadPolicy.

View Source 
var (
	RedisProxy_RedisFault_RedisFaultType_name = map[int32]string{
		0: "DELAY",
		1: "ERROR",
	}
	RedisProxy_RedisFault_RedisFaultType_value = map[string]int32{
		"DELAY": 0,
		"ERROR": 1,
	}
)

Enum value maps for RedisProxy_RedisFault_RedisFaultType.

View Source 
var File_envoy_extensions_filters_network_redis_proxy_v3_redis_proxy_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type RedisProtocolOptions 

type RedisProtocolOptions struct {

	// Upstream server password as defined by the `requirepass` directive
	// <https://redis.io/topics/config>`_ in the server's configuration file.
	AuthPassword *v3.DataSource `protobuf:"bytes,1,opt,name=auth_password,json=authPassword,proto3" json:"auth_password,omitempty"`
	// Upstream server username as defined by the `user` directive
	// <https://redis.io/topics/acl>`_ in the server's configuration file.
	AuthUsername *v3.DataSource `protobuf:"bytes,2,opt,name=auth_username,json=authUsername,proto3" json:"auth_username,omitempty"`
	// contains filtered or unexported fields
}

RedisProtocolOptions specifies Redis upstream protocol options. This object is used in :ref:`typed_extension_protocol_options<envoy_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`, keyed by the name `envoy.filters.network.redis_proxy`.

func (*RedisProtocolOptions) Descriptor deprecated 

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

Deprecated: Use RedisProtocolOptions.ProtoReflect.Descriptor instead.

func (*RedisProtocolOptions) GetAuthPassword 

func (x *RedisProtocolOptions) GetAuthPassword() *v3.DataSource

func (*RedisProtocolOptions) GetAuthUsername 

func (x *RedisProtocolOptions) GetAuthUsername() *v3.DataSource

func (*RedisProtocolOptions) ProtoMessage 

func (*RedisProtocolOptions) ProtoMessage()

func (*RedisProtocolOptions) ProtoReflect 

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

func (*RedisProtocolOptions) Reset 

func (x *RedisProtocolOptions) Reset()

func (*RedisProtocolOptions) String 

func (x *RedisProtocolOptions) String() string

func (*RedisProtocolOptions) Validate 

func (m *RedisProtocolOptions) Validate() error

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

type RedisProtocolOptionsValidationError 

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

RedisProtocolOptionsValidationError is the validation error returned by RedisProtocolOptions.Validate if the designated constraints aren't met.

func (RedisProtocolOptionsValidationError) Cause 

func (e RedisProtocolOptionsValidationError) Cause() error

Cause function returns cause value.

func (RedisProtocolOptionsValidationError) Error 

func (e RedisProtocolOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProtocolOptionsValidationError) ErrorName 

func (e RedisProtocolOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProtocolOptionsValidationError) Field 

func (e RedisProtocolOptionsValidationError) Field() string

Field function returns field value.

func (RedisProtocolOptionsValidationError) Key 

func (e RedisProtocolOptionsValidationError) Key() bool

Key function returns key value.

func (RedisProtocolOptionsValidationError) Reason 

func (e RedisProtocolOptionsValidationError) Reason() string

Reason function returns reason value.

type RedisProxy 

type RedisProxy struct {

	// The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
	StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Network settings for the connection pool to the upstream clusters.
	Settings *RedisProxy_ConnPoolSettings `protobuf:"bytes,3,opt,name=settings,proto3" json:"settings,omitempty"`
	// Indicates that latency stat should be computed in microseconds. By default it is computed in
	// milliseconds. This does not apply to upstream command stats currently.
	LatencyInMicros bool `protobuf:"varint,4,opt,name=latency_in_micros,json=latencyInMicros,proto3" json:"latency_in_micros,omitempty"`
	// List of **unique** prefixes used to separate keys from different workloads to different
	// clusters. Envoy will always favor the longest match first in case of overlap. A catch-all
	// cluster can be used to forward commands when there is no match. Time complexity of the
	// lookups are in O(min(longest key prefix, key length)).
	//
	// Example:
	//
	// .. code-block:: yaml
	//
	//    prefix_routes:
	//      routes:
	//        - prefix: "ab"
	//          cluster: "cluster_a"
	//        - prefix: "abc"
	//          cluster: "cluster_b"
	//
	// When using the above routes, the following prefixes would be sent to:
	//
	// * “get abc:users“ would retrieve the key 'abc:users' from cluster_b.
	// * “get ab:users“ would retrieve the key 'ab:users' from cluster_a.
	// * “get z:users“ would return a NoUpstreamHost error. A :ref:`catch-all
	//   route<envoy_api_field_extensions.filters.network.redis_proxy.v3.RedisProxy.PrefixRoutes.catch_all_route>`
	//   would have retrieved the key from that cluster instead.
	//
	// See the :ref:`configuration section
	// <arch_overview_redis_configuration>` of the architecture overview for recommendations on
	// configuring the backing clusters.
	PrefixRoutes *RedisProxy_PrefixRoutes `protobuf:"bytes,5,opt,name=prefix_routes,json=prefixRoutes,proto3" json:"prefix_routes,omitempty"`
	// Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
	// AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other
	// command. If an AUTH command's password matches this password, an "OK" response will be returned
	// to the client. If the AUTH command password does not match this password, then an "ERR invalid
	// password" error will be returned. If any other command is received before AUTH when this
	// password is set, then a "NOAUTH Authentication required." error response will be sent to the
	// client. If an AUTH command is received when the password is not set, then an "ERR Client sent
	// AUTH, but no password is set" error will be returned.
	DownstreamAuthPassword *v3.DataSource `` /* 129-byte string literal not displayed */
	// List of faults to inject. Faults currently come in two flavors:
	// - Delay, which delays a request.
	// - Error, which responds to a request with an error. Errors can also have delays attached.
	//
	// Example:
	//
	// .. code-block:: yaml
	//
	//    faults:
	//    - fault_type: ERROR
	//      fault_enabled:
	//        default_value:
	//          numerator: 10
	//          denominator: HUNDRED
	//        runtime_key: "bogus_key"
	//        commands:
	//        - GET
	//      - fault_type: DELAY
	//        fault_enabled:
	//          default_value:
	//            numerator: 10
	//            denominator: HUNDRED
	//          runtime_key: "bogus_key"
	//        delay: 2s
	//
	// See the :ref:`fault injection section
	// <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
	Faults []*RedisProxy_RedisFault `protobuf:"bytes,8,rep,name=faults,proto3" json:"faults,omitempty"`
	// If a username is provided an ACL style AUTH command will be required with a username and password.
	// Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
	// AUTH command <https://redis.io/commands/auth>`_ with this username and the *downstream_auth_password*
	// before enabling any other command. If an AUTH command's username and password matches this username
	// and the *downstream_auth_password* , an "OK" response will be returned to the client. If the AUTH
	// command username or password does not match this username or the *downstream_auth_password*, then an
	// "WRONGPASS invalid username-password pair" error will be returned. If any other command is received before AUTH when this
	// password is set, then a "NOAUTH Authentication required." error response will be sent to the
	// client. If an AUTH command is received when the password is not set, then an "ERR Client sent
	// AUTH, but no ACL is set" error will be returned.
	DownstreamAuthUsername *v3.DataSource `` /* 129-byte string literal not displayed */
	// Deprecated: Do not use.
	HiddenEnvoyDeprecatedCluster string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 9]

func (*RedisProxy) Descriptor deprecated 

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

Deprecated: Use RedisProxy.ProtoReflect.Descriptor instead.

func (*RedisProxy) GetDownstreamAuthPassword 

func (x *RedisProxy) GetDownstreamAuthPassword() *v3.DataSource

func (*RedisProxy) GetDownstreamAuthUsername 

func (x *RedisProxy) GetDownstreamAuthUsername() *v3.DataSource

func (*RedisProxy) GetFaults 

func (x *RedisProxy) GetFaults() []*RedisProxy_RedisFault

func (*RedisProxy) GetHiddenEnvoyDeprecatedCluster deprecated 

func (x *RedisProxy) GetHiddenEnvoyDeprecatedCluster() string

Deprecated: Do not use.

func (*RedisProxy) GetLatencyInMicros 

func (x *RedisProxy) GetLatencyInMicros() bool

func (*RedisProxy) GetPrefixRoutes 

func (x *RedisProxy) GetPrefixRoutes() *RedisProxy_PrefixRoutes

func (*RedisProxy) GetSettings 

func (x *RedisProxy) GetSettings() *RedisProxy_ConnPoolSettings

func (*RedisProxy) GetStatPrefix 

func (x *RedisProxy) GetStatPrefix() string

func (*RedisProxy) ProtoMessage 

func (*RedisProxy) ProtoMessage()

func (*RedisProxy) ProtoReflect 

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

func (*RedisProxy) Reset 

func (x *RedisProxy) Reset()

func (*RedisProxy) String 

func (x *RedisProxy) String() string

func (*RedisProxy) Validate 

func (m *RedisProxy) Validate() error

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

type RedisProxyValidationError 

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

RedisProxyValidationError is the validation error returned by RedisProxy.Validate if the designated constraints aren't met.

func (RedisProxyValidationError) Cause 

func (e RedisProxyValidationError) Cause() error

Cause function returns cause value.

func (RedisProxyValidationError) Error 

func (e RedisProxyValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxyValidationError) ErrorName 

func (e RedisProxyValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxyValidationError) Field 

func (e RedisProxyValidationError) Field() string

Field function returns field value.

func (RedisProxyValidationError) Key 

func (e RedisProxyValidationError) Key() bool

Key function returns key value.

func (RedisProxyValidationError) Reason 

func (e RedisProxyValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_ConnPoolSettings 

type RedisProxy_ConnPoolSettings struct {

	// Per-operation timeout in milliseconds. The timer starts when the first
	// command of a pipeline is written to the backend connection. Each response received from Redis
	// resets the timer since it signifies that the next command is being processed by the backend.
	// The only exception to this behavior is when a connection to a backend is not yet established.
	// In that case, the connect timeout on the cluster will govern the timeout until the connection
	// is ready.
	OpTimeout *duration.Duration `protobuf:"bytes,1,opt,name=op_timeout,json=opTimeout,proto3" json:"op_timeout,omitempty"`
	// Use hash tagging on every redis key to guarantee that keys with the same hash tag will be
	// forwarded to the same upstream. The hash key used for determining the upstream in a
	// consistent hash ring configuration will be computed from the hash tagged key instead of the
	// whole key. The algorithm used to compute the hash tag is identical to the `redis-cluster
	// implementation <https://redis.io/topics/cluster-spec#keys-hash-tags>`_.
	//
	// Examples:
	//
	// * '{user1000}.following' and '{user1000}.followers' **will** be sent to the same upstream
	// * '{user1000}.following' and '{user1001}.following' **might** be sent to the same upstream
	EnableHashtagging bool `protobuf:"varint,2,opt,name=enable_hashtagging,json=enableHashtagging,proto3" json:"enable_hashtagging,omitempty"`
	// Accept `moved and ask redirection
	// <https://redis.io/topics/cluster-spec#redirection-and-resharding>`_ errors from upstream
	// redis servers, and retry commands to the specified target server. The target server does not
	// need to be known to the cluster manager. If the command cannot be redirected, then the
	// original error is passed downstream unchanged. By default, this support is not enabled.
	EnableRedirection bool `protobuf:"varint,3,opt,name=enable_redirection,json=enableRedirection,proto3" json:"enable_redirection,omitempty"`
	// Maximum size of encoded request buffer before flush is triggered and encoded requests
	// are sent upstream. If this is unset, the buffer flushes whenever it receives data
	// and performs no batching.
	// This feature makes it possible for multiple clients to send requests to Envoy and have
	// them batched- for example if one is running several worker processes, each with its own
	// Redis connection. There is no benefit to using this with a single downstream process.
	// Recommended size (if enabled) is 1024 bytes.
	MaxBufferSizeBeforeFlush uint32 `` /* 140-byte string literal not displayed */
	// The encoded request buffer is flushed N milliseconds after the first request has been
	// encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`.
	// If `max_buffer_size_before_flush` is not set, this flush timer is not used. Otherwise,
	// the timer should be set according to the number of clients, overall request rate and
	// desired maximum latency for a single command. For example, if there are many requests
	// being batched together at a high rate, the buffer will likely be filled before the timer
	// fires. Alternatively, if the request rate is lower the buffer will not be filled as often
	// before the timer fires.
	// If `max_buffer_size_before_flush` is set, but `buffer_flush_timeout` is not, the latter
	// defaults to 3ms.
	BufferFlushTimeout *duration.Duration `protobuf:"bytes,5,opt,name=buffer_flush_timeout,json=bufferFlushTimeout,proto3" json:"buffer_flush_timeout,omitempty"`
	// `max_upstream_unknown_connections` controls how many upstream connections to unknown hosts
	// can be created at any given time by any given worker thread (see `enable_redirection` for
	// more details). If the host is unknown and a connection cannot be created due to enforcing
	// this limit, then redirection will fail and the original redirection error will be passed
	// downstream unchanged. This limit defaults to 100.
	MaxUpstreamUnknownConnections *wrappers.UInt32Value `` /* 152-byte string literal not displayed */
	// Enable per-command statistics per upstream cluster, in addition to the filter level aggregate
	// count. These commands are measured in microseconds.
	EnableCommandStats bool `protobuf:"varint,8,opt,name=enable_command_stats,json=enableCommandStats,proto3" json:"enable_command_stats,omitempty"`
	// Read policy. The default is to read from the primary.
	ReadPolicy RedisProxy_ConnPoolSettings_ReadPolicy `` /* 184-byte string literal not displayed */
	// contains filtered or unexported fields
}

Redis connection pool settings. [#next-free-field: 9]

func (*RedisProxy_ConnPoolSettings) Descriptor deprecated 

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

Deprecated: Use RedisProxy_ConnPoolSettings.ProtoReflect.Descriptor instead.

func (*RedisProxy_ConnPoolSettings) GetBufferFlushTimeout 

func (x *RedisProxy_ConnPoolSettings) GetBufferFlushTimeout() *duration.Duration

func (*RedisProxy_ConnPoolSettings) GetEnableCommandStats 

func (x *RedisProxy_ConnPoolSettings) GetEnableCommandStats() bool

func (*RedisProxy_ConnPoolSettings) GetEnableHashtagging 

func (x *RedisProxy_ConnPoolSettings) GetEnableHashtagging() bool

func (*RedisProxy_ConnPoolSettings) GetEnableRedirection 

func (x *RedisProxy_ConnPoolSettings) GetEnableRedirection() bool

func (*RedisProxy_ConnPoolSettings) GetMaxBufferSizeBeforeFlush 

func (x *RedisProxy_ConnPoolSettings) GetMaxBufferSizeBeforeFlush() uint32

func (*RedisProxy_ConnPoolSettings) GetMaxUpstreamUnknownConnections 

func (x *RedisProxy_ConnPoolSettings) GetMaxUpstreamUnknownConnections() *wrappers.UInt32Value

func (*RedisProxy_ConnPoolSettings) GetOpTimeout 

func (x *RedisProxy_ConnPoolSettings) GetOpTimeout() *duration.Duration

func (*RedisProxy_ConnPoolSettings) GetReadPolicy 

func (x *RedisProxy_ConnPoolSettings) GetReadPolicy() RedisProxy_ConnPoolSettings_ReadPolicy

func (*RedisProxy_ConnPoolSettings) ProtoMessage 

func (*RedisProxy_ConnPoolSettings) ProtoMessage()

func (*RedisProxy_ConnPoolSettings) ProtoReflect 

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

func (*RedisProxy_ConnPoolSettings) Reset 

func (x *RedisProxy_ConnPoolSettings) Reset()

func (*RedisProxy_ConnPoolSettings) String 

func (x *RedisProxy_ConnPoolSettings) String() string

func (*RedisProxy_ConnPoolSettings) Validate 

func (m *RedisProxy_ConnPoolSettings) Validate() error

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

type RedisProxy_ConnPoolSettingsValidationError 

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

RedisProxy_ConnPoolSettingsValidationError is the validation error returned by RedisProxy_ConnPoolSettings.Validate if the designated constraints aren't met.

func (RedisProxy_ConnPoolSettingsValidationError) Cause 

func (e RedisProxy_ConnPoolSettingsValidationError) Cause() error

Cause function returns cause value.

func (RedisProxy_ConnPoolSettingsValidationError) Error 

func (e RedisProxy_ConnPoolSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxy_ConnPoolSettingsValidationError) ErrorName 

func (e RedisProxy_ConnPoolSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxy_ConnPoolSettingsValidationError) Field 

func (e RedisProxy_ConnPoolSettingsValidationError) Field() string

Field function returns field value.

func (RedisProxy_ConnPoolSettingsValidationError) Key 

func (e RedisProxy_ConnPoolSettingsValidationError) Key() bool

Key function returns key value.

func (RedisProxy_ConnPoolSettingsValidationError) Reason 

func (e RedisProxy_ConnPoolSettingsValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_ConnPoolSettings_ReadPolicy 

type RedisProxy_ConnPoolSettings_ReadPolicy int32

ReadPolicy controls how Envoy routes read commands to Redis nodes. This is currently supported for Redis Cluster. All ReadPolicy settings except MASTER may return stale data because replication is asynchronous and requires some delay. You need to ensure that your application can tolerate stale data. 

const (
	// Default mode. Read from the current primary node.
	RedisProxy_ConnPoolSettings_MASTER RedisProxy_ConnPoolSettings_ReadPolicy = 0
	// Read from the primary, but if it is unavailable, read from replica nodes.
	RedisProxy_ConnPoolSettings_PREFER_MASTER RedisProxy_ConnPoolSettings_ReadPolicy = 1
	// Read from replica nodes. If multiple replica nodes are present within a shard, a random
	// node is selected. Healthy nodes have precedent over unhealthy nodes.
	RedisProxy_ConnPoolSettings_REPLICA RedisProxy_ConnPoolSettings_ReadPolicy = 2
	// Read from the replica nodes (similar to REPLICA), but if all replicas are unavailable (not
	// present or unhealthy), read from the primary.
	RedisProxy_ConnPoolSettings_PREFER_REPLICA RedisProxy_ConnPoolSettings_ReadPolicy = 3
	// Read from any node of the cluster. A random node is selected among the primary and
	// replicas, healthy nodes have precedent over unhealthy nodes.
	RedisProxy_ConnPoolSettings_ANY RedisProxy_ConnPoolSettings_ReadPolicy = 4
)

func (RedisProxy_ConnPoolSettings_ReadPolicy) Descriptor 

func (RedisProxy_ConnPoolSettings_ReadPolicy) Descriptor() protoreflect.EnumDescriptor

func (RedisProxy_ConnPoolSettings_ReadPolicy) Enum 

func (x RedisProxy_ConnPoolSettings_ReadPolicy) Enum() *RedisProxy_ConnPoolSettings_ReadPolicy

func (RedisProxy_ConnPoolSettings_ReadPolicy) EnumDescriptor deprecated 

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

Deprecated: Use RedisProxy_ConnPoolSettings_ReadPolicy.Descriptor instead.

func (RedisProxy_ConnPoolSettings_ReadPolicy) Number 

func (x RedisProxy_ConnPoolSettings_ReadPolicy) Number() protoreflect.EnumNumber

func (RedisProxy_ConnPoolSettings_ReadPolicy) String 

func (x RedisProxy_ConnPoolSettings_ReadPolicy) String() string

func (RedisProxy_ConnPoolSettings_ReadPolicy) Type 

func (RedisProxy_ConnPoolSettings_ReadPolicy) Type() protoreflect.EnumType

type RedisProxy_PrefixRoutes 

type RedisProxy_PrefixRoutes struct {

	// List of prefix routes.
	Routes []*RedisProxy_PrefixRoutes_Route `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
	// Indicates that prefix matching should be case insensitive.
	CaseInsensitive bool `protobuf:"varint,2,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"`
	// Optional catch-all route to forward commands that doesn't match any of the routes. The
	// catch-all route becomes required when no routes are specified.
	CatchAllRoute *RedisProxy_PrefixRoutes_Route `protobuf:"bytes,4,opt,name=catch_all_route,json=catchAllRoute,proto3" json:"catch_all_route,omitempty"`
	// Deprecated: Do not use.
	HiddenEnvoyDeprecatedCatchAllCluster string `` /* 177-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RedisProxy_PrefixRoutes) Descriptor deprecated 

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

Deprecated: Use RedisProxy_PrefixRoutes.ProtoReflect.Descriptor instead.

func (*RedisProxy_PrefixRoutes) GetCaseInsensitive 

func (x *RedisProxy_PrefixRoutes) GetCaseInsensitive() bool

func (*RedisProxy_PrefixRoutes) GetCatchAllRoute 

func (x *RedisProxy_PrefixRoutes) GetCatchAllRoute() *RedisProxy_PrefixRoutes_Route

func (*RedisProxy_PrefixRoutes) GetHiddenEnvoyDeprecatedCatchAllCluster deprecated 

func (x *RedisProxy_PrefixRoutes) GetHiddenEnvoyDeprecatedCatchAllCluster() string

Deprecated: Do not use.

func (*RedisProxy_PrefixRoutes) GetRoutes 

func (x *RedisProxy_PrefixRoutes) GetRoutes() []*RedisProxy_PrefixRoutes_Route

func (*RedisProxy_PrefixRoutes) ProtoMessage 

func (*RedisProxy_PrefixRoutes) ProtoMessage()

func (*RedisProxy_PrefixRoutes) ProtoReflect 

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

func (*RedisProxy_PrefixRoutes) Reset 

func (x *RedisProxy_PrefixRoutes) Reset()

func (*RedisProxy_PrefixRoutes) String 

func (x *RedisProxy_PrefixRoutes) String() string

func (*RedisProxy_PrefixRoutes) Validate 

func (m *RedisProxy_PrefixRoutes) Validate() error

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

type RedisProxy_PrefixRoutesValidationError 

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

RedisProxy_PrefixRoutesValidationError is the validation error returned by RedisProxy_PrefixRoutes.Validate if the designated constraints aren't met.

func (RedisProxy_PrefixRoutesValidationError) Cause 

func (e RedisProxy_PrefixRoutesValidationError) Cause() error

Cause function returns cause value.

func (RedisProxy_PrefixRoutesValidationError) Error 

func (e RedisProxy_PrefixRoutesValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxy_PrefixRoutesValidationError) ErrorName 

func (e RedisProxy_PrefixRoutesValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxy_PrefixRoutesValidationError) Field 

func (e RedisProxy_PrefixRoutesValidationError) Field() string

Field function returns field value.

func (RedisProxy_PrefixRoutesValidationError) Key 

func (e RedisProxy_PrefixRoutesValidationError) Key() bool

Key function returns key value.

func (RedisProxy_PrefixRoutesValidationError) Reason 

func (e RedisProxy_PrefixRoutesValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_PrefixRoutes_Route 

type RedisProxy_PrefixRoutes_Route struct {

	// String prefix that must match the beginning of the keys. Envoy will always favor the
	// longest match.
	Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Indicates if the prefix needs to be removed from the key when forwarded.
	RemovePrefix bool `protobuf:"varint,2,opt,name=remove_prefix,json=removePrefix,proto3" json:"remove_prefix,omitempty"`
	// Upstream cluster to forward the command to.
	Cluster string `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// Indicates that the route has a request mirroring policy.
	RequestMirrorPolicy []*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy `protobuf:"bytes,4,rep,name=request_mirror_policy,json=requestMirrorPolicy,proto3" json:"request_mirror_policy,omitempty"`
	// contains filtered or unexported fields
}

func (*RedisProxy_PrefixRoutes_Route) Descriptor deprecated 

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

Deprecated: Use RedisProxy_PrefixRoutes_Route.ProtoReflect.Descriptor instead.

func (*RedisProxy_PrefixRoutes_Route) GetCluster 

func (x *RedisProxy_PrefixRoutes_Route) GetCluster() string

func (*RedisProxy_PrefixRoutes_Route) GetPrefix 

func (x *RedisProxy_PrefixRoutes_Route) GetPrefix() string

func (*RedisProxy_PrefixRoutes_Route) GetRemovePrefix 

func (x *RedisProxy_PrefixRoutes_Route) GetRemovePrefix() bool

func (*RedisProxy_PrefixRoutes_Route) GetRequestMirrorPolicy 

func (x *RedisProxy_PrefixRoutes_Route) GetRequestMirrorPolicy() []*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy

func (*RedisProxy_PrefixRoutes_Route) ProtoMessage 

func (*RedisProxy_PrefixRoutes_Route) ProtoMessage()

func (*RedisProxy_PrefixRoutes_Route) ProtoReflect 

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

func (*RedisProxy_PrefixRoutes_Route) Reset 

func (x *RedisProxy_PrefixRoutes_Route) Reset()

func (*RedisProxy_PrefixRoutes_Route) String 

func (x *RedisProxy_PrefixRoutes_Route) String() string

func (*RedisProxy_PrefixRoutes_Route) Validate 

func (m *RedisProxy_PrefixRoutes_Route) Validate() error

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

type RedisProxy_PrefixRoutes_RouteValidationError 

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

RedisProxy_PrefixRoutes_RouteValidationError is the validation error returned by RedisProxy_PrefixRoutes_Route.Validate if the designated constraints aren't met.

func (RedisProxy_PrefixRoutes_RouteValidationError) Cause 

func (e RedisProxy_PrefixRoutes_RouteValidationError) Cause() error

Cause function returns cause value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Error 

func (e RedisProxy_PrefixRoutes_RouteValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxy_PrefixRoutes_RouteValidationError) ErrorName 

func (e RedisProxy_PrefixRoutes_RouteValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxy_PrefixRoutes_RouteValidationError) Field 

func (e RedisProxy_PrefixRoutes_RouteValidationError) Field() string

Field function returns field value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Key 

func (e RedisProxy_PrefixRoutes_RouteValidationError) Key() bool

Key function returns key value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Reason 

func (e RedisProxy_PrefixRoutes_RouteValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy 

type RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy struct {

	// Specifies the cluster that requests will be mirrored to. The cluster must
	// exist in the cluster manager configuration.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// If not specified or the runtime key is not present, all requests to the target cluster
	// will be mirrored.
	//
	// If specified, Envoy will lookup the runtime key to get the percentage of requests to the
	// mirror.
	RuntimeFraction *v3.RuntimeFractionalPercent `protobuf:"bytes,2,opt,name=runtime_fraction,json=runtimeFraction,proto3" json:"runtime_fraction,omitempty"`
	// Set this to TRUE to only mirror write commands, this is effectively replicating the
	// writes in a "fire and forget" manner.
	ExcludeReadCommands bool `protobuf:"varint,3,opt,name=exclude_read_commands,json=excludeReadCommands,proto3" json:"exclude_read_commands,omitempty"`
	// contains filtered or unexported fields
}

The router is capable of shadowing traffic from one cluster to another. The current implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. All normal statistics are collected for the shadow cluster making this feature useful for testing.

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) Descriptor deprecated 

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

Deprecated: Use RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy.ProtoReflect.Descriptor instead.

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetCluster 

func (x *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetCluster() string

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetExcludeReadCommands 

func (x *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetExcludeReadCommands() bool

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetRuntimeFraction 

func (x *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) GetRuntimeFraction() *v3.RuntimeFractionalPercent

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) ProtoMessage 

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) ProtoMessage()

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) ProtoReflect 

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

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) Reset 

func (x *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) Reset()

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) String 

func (x *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) String() string

func (*RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) Validate 

func (m *RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy) Validate() error

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

type RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError 

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

RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError is the validation error returned by RedisProxy_PrefixRoutes_Route_RequestMirrorPolicy.Validate if the designated constraints aren't met.

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Cause 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Cause() error

Cause function returns cause value.

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Error 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) ErrorName 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Field 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Field() string

Field function returns field value.

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Key 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Key() bool

Key function returns key value.

func (RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Reason 

func (e RedisProxy_PrefixRoutes_Route_RequestMirrorPolicyValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_RedisFault 

type RedisProxy_RedisFault struct {

	// Fault type.
	FaultType RedisProxy_RedisFault_RedisFaultType `` /* 179-byte string literal not displayed */
	// Percentage of requests fault applies to.
	FaultEnabled *v3.RuntimeFractionalPercent `protobuf:"bytes,2,opt,name=fault_enabled,json=faultEnabled,proto3" json:"fault_enabled,omitempty"`
	// Delay for all faults. If not set, defaults to zero
	Delay *duration.Duration `protobuf:"bytes,3,opt,name=delay,proto3" json:"delay,omitempty"`
	// Commands fault is restricted to, if any. If not set, fault applies to all commands
	// other than auth and ping (due to special handling of those commands in Envoy).
	Commands []string `protobuf:"bytes,4,rep,name=commands,proto3" json:"commands,omitempty"`
	// contains filtered or unexported fields
}

RedisFault defines faults used for fault injection.

func (*RedisProxy_RedisFault) Descriptor deprecated 

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

Deprecated: Use RedisProxy_RedisFault.ProtoReflect.Descriptor instead.

func (*RedisProxy_RedisFault) GetCommands 

func (x *RedisProxy_RedisFault) GetCommands() []string

func (*RedisProxy_RedisFault) GetDelay 

func (x *RedisProxy_RedisFault) GetDelay() *duration.Duration

func (*RedisProxy_RedisFault) GetFaultEnabled 

func (x *RedisProxy_RedisFault) GetFaultEnabled() *v3.RuntimeFractionalPercent

func (*RedisProxy_RedisFault) GetFaultType 

func (x *RedisProxy_RedisFault) GetFaultType() RedisProxy_RedisFault_RedisFaultType

func (*RedisProxy_RedisFault) ProtoMessage 

func (*RedisProxy_RedisFault) ProtoMessage()

func (*RedisProxy_RedisFault) ProtoReflect 

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

func (*RedisProxy_RedisFault) Reset 

func (x *RedisProxy_RedisFault) Reset()

func (*RedisProxy_RedisFault) String 

func (x *RedisProxy_RedisFault) String() string

func (*RedisProxy_RedisFault) Validate 

func (m *RedisProxy_RedisFault) Validate() error

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

type RedisProxy_RedisFaultValidationError 

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

RedisProxy_RedisFaultValidationError is the validation error returned by RedisProxy_RedisFault.Validate if the designated constraints aren't met.

func (RedisProxy_RedisFaultValidationError) Cause 

func (e RedisProxy_RedisFaultValidationError) Cause() error

Cause function returns cause value.

func (RedisProxy_RedisFaultValidationError) Error 

func (e RedisProxy_RedisFaultValidationError) Error() string

Error satisfies the builtin error interface

func (RedisProxy_RedisFaultValidationError) ErrorName 

func (e RedisProxy_RedisFaultValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxy_RedisFaultValidationError) Field 

func (e RedisProxy_RedisFaultValidationError) Field() string

Field function returns field value.

func (RedisProxy_RedisFaultValidationError) Key 

func (e RedisProxy_RedisFaultValidationError) Key() bool

Key function returns key value.

func (RedisProxy_RedisFaultValidationError) Reason 

func (e RedisProxy_RedisFaultValidationError) Reason() string

Reason function returns reason value.

type RedisProxy_RedisFault_RedisFaultType 

type RedisProxy_RedisFault_RedisFaultType int32
const (
	// Delays requests. This is the base fault; other faults can have delays added.
	RedisProxy_RedisFault_DELAY RedisProxy_RedisFault_RedisFaultType = 0
	// Returns errors on requests.
	RedisProxy_RedisFault_ERROR RedisProxy_RedisFault_RedisFaultType = 1
)

func (RedisProxy_RedisFault_RedisFaultType) Descriptor 

func (RedisProxy_RedisFault_RedisFaultType) Descriptor() protoreflect.EnumDescriptor

func (RedisProxy_RedisFault_RedisFaultType) Enum 

func (x RedisProxy_RedisFault_RedisFaultType) Enum() *RedisProxy_RedisFault_RedisFaultType

func (RedisProxy_RedisFault_RedisFaultType) EnumDescriptor deprecated 

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

Deprecated: Use RedisProxy_RedisFault_RedisFaultType.Descriptor instead.

func (RedisProxy_RedisFault_RedisFaultType) Number 

func (x RedisProxy_RedisFault_RedisFaultType) Number() protoreflect.EnumNumber

func (RedisProxy_RedisFault_RedisFaultType) String 

func (x RedisProxy_RedisFault_RedisFaultType) String() string

func (RedisProxy_RedisFault_RedisFaultType) Type 

func (RedisProxy_RedisFault_RedisFaultType) Type() protoreflect.EnumType

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.