Documentation
¶
Index ¶
- Variables
- type MongoProxy
- func (*MongoProxy) Descriptor() ([]byte, []int)deprecated
- func (x *MongoProxy) GetAccessLog() string
- func (x *MongoProxy) GetCommands() []string
- func (x *MongoProxy) GetDelay() *v3.FaultDelay
- func (x *MongoProxy) GetEmitDynamicMetadata() bool
- func (x *MongoProxy) GetStatPrefix() string
- func (*MongoProxy) ProtoMessage()
- func (x *MongoProxy) ProtoReflect() protoreflect.Message
- func (x *MongoProxy) Reset()
- func (x *MongoProxy) String() string
- func (m *MongoProxy) Validate() error
- func (m *MongoProxy) ValidateAll() error
- type MongoProxyMultiError
- type MongoProxyValidationError
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_network_mongo_proxy_v3_mongo_proxy_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type MongoProxy ¶
type MongoProxy struct {
// The human readable prefix to use when emitting :ref:`statistics
// <config_network_filters_mongo_proxy_stats>`.
StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
// The optional path to use for writing Mongo access logs. If not access log
// path is specified no access logs will be written. Note that access log is
// also gated :ref:`runtime <config_network_filters_mongo_proxy_runtime>`.
AccessLog string `protobuf:"bytes,2,opt,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
// Inject a fixed delay before proxying a Mongo operation. Delays are
// applied to the following MongoDB operations: Query, Insert, GetMore,
// and KillCursors. Once an active delay is in progress, all incoming
// data up until the timer event fires will be a part of the delay.
Delay *v3.FaultDelay `protobuf:"bytes,3,opt,name=delay,proto3" json:"delay,omitempty"`
// Flag to specify whether :ref:`dynamic metadata
// <config_network_filters_mongo_proxy_dynamic_metadata>` should be emitted. Defaults to false.
EmitDynamicMetadata bool `protobuf:"varint,4,opt,name=emit_dynamic_metadata,json=emitDynamicMetadata,proto3" json:"emit_dynamic_metadata,omitempty"`
// List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
// Note that metrics will not be emitted for "find" commands, since those are considered
// queries, and metrics for those are emitted under a dedicated "query" namespace.
Commands []string `protobuf:"bytes,5,rep,name=commands,proto3" json:"commands,omitempty"`
// contains filtered or unexported fields
}
[#next-free-field: 6]
func (*MongoProxy) Descriptor
deprecated
func (*MongoProxy) Descriptor() ([]byte, []int)
Deprecated: Use MongoProxy.ProtoReflect.Descriptor instead.
func (*MongoProxy) GetAccessLog ¶
func (x *MongoProxy) GetAccessLog() string
func (*MongoProxy) GetCommands ¶ added in v0.9.8
func (x *MongoProxy) GetCommands() []string
func (*MongoProxy) GetDelay ¶
func (x *MongoProxy) GetDelay() *v3.FaultDelay
func (*MongoProxy) GetEmitDynamicMetadata ¶
func (x *MongoProxy) GetEmitDynamicMetadata() bool
func (*MongoProxy) GetStatPrefix ¶
func (x *MongoProxy) GetStatPrefix() string
func (*MongoProxy) ProtoMessage ¶
func (*MongoProxy) ProtoMessage()
func (*MongoProxy) ProtoReflect ¶ added in v0.9.6
func (x *MongoProxy) ProtoReflect() protoreflect.Message
func (*MongoProxy) Reset ¶
func (x *MongoProxy) Reset()
func (*MongoProxy) String ¶
func (x *MongoProxy) String() string
func (*MongoProxy) Validate ¶
func (m *MongoProxy) Validate() error
Validate checks the field values on MongoProxy 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 (*MongoProxy) ValidateAll ¶ added in v0.10.0
func (m *MongoProxy) ValidateAll() error
ValidateAll checks the field values on MongoProxy 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 MongoProxyMultiError, or nil if none found.
type MongoProxyMultiError ¶ added in v0.10.0
type MongoProxyMultiError []error
MongoProxyMultiError is an error wrapping multiple validation errors returned by MongoProxy.ValidateAll() if the designated constraints aren't met.
func (MongoProxyMultiError) AllErrors ¶ added in v0.10.0
func (m MongoProxyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (MongoProxyMultiError) Error ¶ added in v0.10.0
func (m MongoProxyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type MongoProxyValidationError ¶
type MongoProxyValidationError struct {
// contains filtered or unexported fields
}
MongoProxyValidationError is the validation error returned by MongoProxy.Validate if the designated constraints aren't met.
func (MongoProxyValidationError) Cause ¶
func (e MongoProxyValidationError) Cause() error
Cause function returns cause value.
func (MongoProxyValidationError) Error ¶
func (e MongoProxyValidationError) Error() string
Error satisfies the builtin error interface
func (MongoProxyValidationError) ErrorName ¶
func (e MongoProxyValidationError) ErrorName() string
ErrorName returns error name.
func (MongoProxyValidationError) Field ¶
func (e MongoProxyValidationError) Field() string
Field function returns field value.
func (MongoProxyValidationError) Key ¶
func (e MongoProxyValidationError) Key() bool
Key function returns key value.
func (MongoProxyValidationError) Reason ¶
func (e MongoProxyValidationError) Reason() string
Reason function returns reason value.
Source Files