v2

package
v0.7.1 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2019 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthRedisProxy = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRedisProxy   = fmt.Errorf("proto: integer overflow")
)

Functions

This section is empty.

Types

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"`
	// Name of cluster from cluster manager. See the :ref:`configuration section
	// <arch_overview_redis_configuration>` of the architecture overview for recommendations on
	// configuring the backing cluster.
	//
	// .. attention::
	//
	//   This field is deprecated. Use a :ref:`catch-all
	//   cluster<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_cluster>`
	//   instead.
	Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3" json:"cluster,omitempty"` // Deprecated: Do not use.
	// 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.
	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 retrive the key 'abc:users' from cluster_b.
	// * 'get ab:users' would retrive the key 'ab:users' from cluster_a.
	// * 'get z:users' would return a NoUpstreamHost error. A :ref:`catch-all
	//   cluster<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_cluster>`
	//   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"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

func (*RedisProxy) Descriptor

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

func (*RedisProxy) GetCluster deprecated

func (m *RedisProxy) GetCluster() string

Deprecated: Do not use.

func (*RedisProxy) GetLatencyInMicros added in v0.7.0

func (m *RedisProxy) GetLatencyInMicros() bool

func (*RedisProxy) GetPrefixRoutes added in v0.7.1

func (m *RedisProxy) GetPrefixRoutes() RedisProxy_PrefixRoutes

func (*RedisProxy) GetSettings

func (m *RedisProxy) GetSettings() *RedisProxy_ConnPoolSettings

func (*RedisProxy) GetStatPrefix

func (m *RedisProxy) GetStatPrefix() string

func (*RedisProxy) Marshal

func (m *RedisProxy) Marshal() (dAtA []byte, err error)

func (*RedisProxy) MarshalTo

func (m *RedisProxy) MarshalTo(dAtA []byte) (int, error)

func (*RedisProxy) ProtoMessage

func (*RedisProxy) ProtoMessage()

func (*RedisProxy) Reset

func (m *RedisProxy) Reset()

func (*RedisProxy) Size

func (m *RedisProxy) Size() (n int)

func (*RedisProxy) String

func (m *RedisProxy) String() string

func (*RedisProxy) Unmarshal

func (m *RedisProxy) Unmarshal(dAtA []byte) error

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.

func (*RedisProxy) XXX_DiscardUnknown

func (m *RedisProxy) XXX_DiscardUnknown()

func (*RedisProxy) XXX_Marshal

func (m *RedisProxy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RedisProxy) XXX_Merge

func (m *RedisProxy) XXX_Merge(src proto.Message)

func (*RedisProxy) XXX_Size

func (m *RedisProxy) XXX_Size() int

func (*RedisProxy) XXX_Unmarshal

func (m *RedisProxy) XXX_Unmarshal(b []byte) error

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

Error satisfies the builtin error interface

func (RedisProxyValidationError) ErrorName added in v0.7.0

func (e RedisProxyValidationError) ErrorName() string

ErrorName returns error name.

func (RedisProxyValidationError) Field

Field function returns field value.

func (RedisProxyValidationError) Key

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 *time.Duration `protobuf:"bytes,1,opt,name=op_timeout,json=opTimeout,proto3,stdduration" 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   *time.Duration `` /* 129-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

Redis connection pool settings.

func (*RedisProxy_ConnPoolSettings) Descriptor

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

func (*RedisProxy_ConnPoolSettings) GetBufferFlushTimeout added in v0.7.1

func (m *RedisProxy_ConnPoolSettings) GetBufferFlushTimeout() *time.Duration

func (*RedisProxy_ConnPoolSettings) GetEnableHashtagging added in v0.6.8

func (m *RedisProxy_ConnPoolSettings) GetEnableHashtagging() bool

func (*RedisProxy_ConnPoolSettings) GetEnableRedirection added in v0.7.1

func (m *RedisProxy_ConnPoolSettings) GetEnableRedirection() bool

func (*RedisProxy_ConnPoolSettings) GetMaxBufferSizeBeforeFlush added in v0.7.1

func (m *RedisProxy_ConnPoolSettings) GetMaxBufferSizeBeforeFlush() uint32

func (*RedisProxy_ConnPoolSettings) GetOpTimeout

func (m *RedisProxy_ConnPoolSettings) GetOpTimeout() *time.Duration

func (*RedisProxy_ConnPoolSettings) Marshal

func (m *RedisProxy_ConnPoolSettings) Marshal() (dAtA []byte, err error)

func (*RedisProxy_ConnPoolSettings) MarshalTo

func (m *RedisProxy_ConnPoolSettings) MarshalTo(dAtA []byte) (int, error)

func (*RedisProxy_ConnPoolSettings) ProtoMessage

func (*RedisProxy_ConnPoolSettings) ProtoMessage()

func (*RedisProxy_ConnPoolSettings) Reset

func (m *RedisProxy_ConnPoolSettings) Reset()

func (*RedisProxy_ConnPoolSettings) Size

func (m *RedisProxy_ConnPoolSettings) Size() (n int)

func (*RedisProxy_ConnPoolSettings) String

func (m *RedisProxy_ConnPoolSettings) String() string

func (*RedisProxy_ConnPoolSettings) Unmarshal

func (m *RedisProxy_ConnPoolSettings) Unmarshal(dAtA []byte) error

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.

func (*RedisProxy_ConnPoolSettings) XXX_DiscardUnknown

func (m *RedisProxy_ConnPoolSettings) XXX_DiscardUnknown()

func (*RedisProxy_ConnPoolSettings) XXX_Marshal

func (m *RedisProxy_ConnPoolSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RedisProxy_ConnPoolSettings) XXX_Merge

func (m *RedisProxy_ConnPoolSettings) XXX_Merge(src proto.Message)

func (*RedisProxy_ConnPoolSettings) XXX_Size

func (m *RedisProxy_ConnPoolSettings) XXX_Size() int

func (*RedisProxy_ConnPoolSettings) XXX_Unmarshal

func (m *RedisProxy_ConnPoolSettings) XXX_Unmarshal(b []byte) error

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

Cause function returns cause value.

func (RedisProxy_ConnPoolSettingsValidationError) Error

Error satisfies the builtin error interface

func (RedisProxy_ConnPoolSettingsValidationError) ErrorName added in v0.7.0

ErrorName returns error name.

func (RedisProxy_ConnPoolSettingsValidationError) Field

Field function returns field value.

func (RedisProxy_ConnPoolSettingsValidationError) Key

Key function returns key value.

func (RedisProxy_ConnPoolSettingsValidationError) Reason

Reason function returns reason value.

type RedisProxy_PrefixRoutes added in v0.7.1

type RedisProxy_PrefixRoutes struct {
	// List of prefix routes.
	Routes []RedisProxy_PrefixRoutes_Route `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes"`
	// 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.
	CatchAllCluster      string   `protobuf:"bytes,3,opt,name=catch_all_cluster,json=catchAllCluster,proto3" json:"catch_all_cluster,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RedisProxy_PrefixRoutes) Descriptor added in v0.7.1

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

func (*RedisProxy_PrefixRoutes) GetCaseInsensitive added in v0.7.1

func (m *RedisProxy_PrefixRoutes) GetCaseInsensitive() bool

func (*RedisProxy_PrefixRoutes) GetCatchAllCluster added in v0.7.1

func (m *RedisProxy_PrefixRoutes) GetCatchAllCluster() string

func (*RedisProxy_PrefixRoutes) GetRoutes added in v0.7.1

func (*RedisProxy_PrefixRoutes) Marshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes) Marshal() (dAtA []byte, err error)

func (*RedisProxy_PrefixRoutes) MarshalTo added in v0.7.1

func (m *RedisProxy_PrefixRoutes) MarshalTo(dAtA []byte) (int, error)

func (*RedisProxy_PrefixRoutes) ProtoMessage added in v0.7.1

func (*RedisProxy_PrefixRoutes) ProtoMessage()

func (*RedisProxy_PrefixRoutes) Reset added in v0.7.1

func (m *RedisProxy_PrefixRoutes) Reset()

func (*RedisProxy_PrefixRoutes) Size added in v0.7.1

func (m *RedisProxy_PrefixRoutes) Size() (n int)

func (*RedisProxy_PrefixRoutes) String added in v0.7.1

func (m *RedisProxy_PrefixRoutes) String() string

func (*RedisProxy_PrefixRoutes) Unmarshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes) Unmarshal(dAtA []byte) error

func (*RedisProxy_PrefixRoutes) Validate added in v0.7.1

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.

func (*RedisProxy_PrefixRoutes) XXX_DiscardUnknown added in v0.7.1

func (m *RedisProxy_PrefixRoutes) XXX_DiscardUnknown()

func (*RedisProxy_PrefixRoutes) XXX_Marshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RedisProxy_PrefixRoutes) XXX_Merge added in v0.7.1

func (m *RedisProxy_PrefixRoutes) XXX_Merge(src proto.Message)

func (*RedisProxy_PrefixRoutes) XXX_Size added in v0.7.1

func (m *RedisProxy_PrefixRoutes) XXX_Size() int

func (*RedisProxy_PrefixRoutes) XXX_Unmarshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes) XXX_Unmarshal(b []byte) error

type RedisProxy_PrefixRoutesValidationError added in v0.7.1

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 added in v0.7.1

Cause function returns cause value.

func (RedisProxy_PrefixRoutesValidationError) Error added in v0.7.1

Error satisfies the builtin error interface

func (RedisProxy_PrefixRoutesValidationError) ErrorName added in v0.7.1

ErrorName returns error name.

func (RedisProxy_PrefixRoutesValidationError) Field added in v0.7.1

Field function returns field value.

func (RedisProxy_PrefixRoutesValidationError) Key added in v0.7.1

Key function returns key value.

func (RedisProxy_PrefixRoutesValidationError) Reason added in v0.7.1

Reason function returns reason value.

type RedisProxy_PrefixRoutes_Route added in v0.7.1

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RedisProxy_PrefixRoutes_Route) Descriptor added in v0.7.1

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

func (*RedisProxy_PrefixRoutes_Route) GetCluster added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) GetCluster() string

func (*RedisProxy_PrefixRoutes_Route) GetPrefix added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) GetPrefix() string

func (*RedisProxy_PrefixRoutes_Route) GetRemovePrefix added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) GetRemovePrefix() bool

func (*RedisProxy_PrefixRoutes_Route) Marshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) Marshal() (dAtA []byte, err error)

func (*RedisProxy_PrefixRoutes_Route) MarshalTo added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) MarshalTo(dAtA []byte) (int, error)

func (*RedisProxy_PrefixRoutes_Route) ProtoMessage added in v0.7.1

func (*RedisProxy_PrefixRoutes_Route) ProtoMessage()

func (*RedisProxy_PrefixRoutes_Route) Reset added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) Reset()

func (*RedisProxy_PrefixRoutes_Route) Size added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) Size() (n int)

func (*RedisProxy_PrefixRoutes_Route) String added in v0.7.1

func (*RedisProxy_PrefixRoutes_Route) Unmarshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) Unmarshal(dAtA []byte) error

func (*RedisProxy_PrefixRoutes_Route) Validate added in v0.7.1

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.

func (*RedisProxy_PrefixRoutes_Route) XXX_DiscardUnknown added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) XXX_DiscardUnknown()

func (*RedisProxy_PrefixRoutes_Route) XXX_Marshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RedisProxy_PrefixRoutes_Route) XXX_Merge added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) XXX_Merge(src proto.Message)

func (*RedisProxy_PrefixRoutes_Route) XXX_Size added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) XXX_Size() int

func (*RedisProxy_PrefixRoutes_Route) XXX_Unmarshal added in v0.7.1

func (m *RedisProxy_PrefixRoutes_Route) XXX_Unmarshal(b []byte) error

type RedisProxy_PrefixRoutes_RouteValidationError added in v0.7.1

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 added in v0.7.1

Cause function returns cause value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Error added in v0.7.1

Error satisfies the builtin error interface

func (RedisProxy_PrefixRoutes_RouteValidationError) ErrorName added in v0.7.1

ErrorName returns error name.

func (RedisProxy_PrefixRoutes_RouteValidationError) Field added in v0.7.1

Field function returns field value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Key added in v0.7.1

Key function returns key value.

func (RedisProxy_PrefixRoutes_RouteValidationError) Reason added in v0.7.1

Reason function returns reason value.

Jump to

Keyboard shortcuts

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