Documentation
¶
Index ¶
- Variables
- type FaultAbort
- func (*FaultAbort) Descriptor() ([]byte, []int)deprecated
- func (m *FaultAbort) GetErrorType() isFaultAbort_ErrorType
- func (x *FaultAbort) GetGrpcStatus() uint32
- func (x *FaultAbort) GetHeaderAbort() *FaultAbort_HeaderAbort
- func (x *FaultAbort) GetHttpStatus() uint32
- func (x *FaultAbort) GetPercentage() *v3.FractionalPercent
- func (*FaultAbort) ProtoMessage()
- func (x *FaultAbort) ProtoReflect() protoreflect.Message
- func (x *FaultAbort) Reset()
- func (x *FaultAbort) String() string
- func (m *FaultAbort) Validate() error
- func (m *FaultAbort) ValidateAll() error
- type FaultAbortMultiError
- type FaultAbortValidationError
- type FaultAbort_GrpcStatus
- type FaultAbort_HeaderAbort
- func (*FaultAbort_HeaderAbort) Descriptor() ([]byte, []int)deprecated
- func (*FaultAbort_HeaderAbort) ProtoMessage()
- func (x *FaultAbort_HeaderAbort) ProtoReflect() protoreflect.Message
- func (x *FaultAbort_HeaderAbort) Reset()
- func (x *FaultAbort_HeaderAbort) String() string
- func (m *FaultAbort_HeaderAbort) Validate() error
- func (m *FaultAbort_HeaderAbort) ValidateAll() error
- type FaultAbort_HeaderAbortMultiError
- type FaultAbort_HeaderAbortValidationError
- func (e FaultAbort_HeaderAbortValidationError) Cause() error
- func (e FaultAbort_HeaderAbortValidationError) Error() string
- func (e FaultAbort_HeaderAbortValidationError) ErrorName() string
- func (e FaultAbort_HeaderAbortValidationError) Field() string
- func (e FaultAbort_HeaderAbortValidationError) Key() bool
- func (e FaultAbort_HeaderAbortValidationError) Reason() string
- type FaultAbort_HeaderAbort_
- type FaultAbort_HttpStatus
- type HTTPFault
- func (*HTTPFault) Descriptor() ([]byte, []int)deprecated
- func (x *HTTPFault) GetAbort() *FaultAbort
- func (x *HTTPFault) GetAbortGrpcStatusRuntime() string
- func (x *HTTPFault) GetAbortHttpStatusRuntime() string
- func (x *HTTPFault) GetAbortPercentRuntime() string
- func (x *HTTPFault) GetDelay() *v31.FaultDelay
- func (x *HTTPFault) GetDelayDurationRuntime() string
- func (x *HTTPFault) GetDelayPercentRuntime() string
- func (x *HTTPFault) GetDisableDownstreamClusterStats() bool
- func (x *HTTPFault) GetDownstreamNodes() []string
- func (x *HTTPFault) GetHeaders() []*v32.HeaderMatcher
- func (x *HTTPFault) GetMaxActiveFaults() *wrappers.UInt32Value
- func (x *HTTPFault) GetMaxActiveFaultsRuntime() string
- func (x *HTTPFault) GetResponseRateLimit() *v31.FaultRateLimit
- func (x *HTTPFault) GetResponseRateLimitPercentRuntime() string
- func (x *HTTPFault) GetUpstreamCluster() string
- func (*HTTPFault) ProtoMessage()
- func (x *HTTPFault) ProtoReflect() protoreflect.Message
- func (x *HTTPFault) Reset()
- func (x *HTTPFault) String() string
- func (m *HTTPFault) Validate() error
- func (m *HTTPFault) ValidateAll() error
- type HTTPFaultMultiError
- type HTTPFaultValidationError
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_fault_v3_fault_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FaultAbort ¶
type FaultAbort struct { // Types that are assignable to ErrorType: // *FaultAbort_HttpStatus // *FaultAbort_GrpcStatus // *FaultAbort_HeaderAbort_ ErrorType isFaultAbort_ErrorType `protobuf_oneof:"error_type"` // The percentage of requests/operations/connections that will be aborted with the error code // provided. Percentage *v3.FractionalPercent `protobuf:"bytes,3,opt,name=percentage,proto3" json:"percentage,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 6]
func (*FaultAbort) Descriptor
deprecated
func (*FaultAbort) Descriptor() ([]byte, []int)
Deprecated: Use FaultAbort.ProtoReflect.Descriptor instead.
func (*FaultAbort) GetErrorType ¶
func (m *FaultAbort) GetErrorType() isFaultAbort_ErrorType
func (*FaultAbort) GetGrpcStatus ¶ added in v0.9.6
func (x *FaultAbort) GetGrpcStatus() uint32
func (*FaultAbort) GetHeaderAbort ¶ added in v0.9.5
func (x *FaultAbort) GetHeaderAbort() *FaultAbort_HeaderAbort
func (*FaultAbort) GetHttpStatus ¶
func (x *FaultAbort) GetHttpStatus() uint32
func (*FaultAbort) GetPercentage ¶
func (x *FaultAbort) GetPercentage() *v3.FractionalPercent
func (*FaultAbort) ProtoMessage ¶
func (*FaultAbort) ProtoMessage()
func (*FaultAbort) ProtoReflect ¶ added in v0.9.6
func (x *FaultAbort) ProtoReflect() protoreflect.Message
func (*FaultAbort) Reset ¶
func (x *FaultAbort) Reset()
func (*FaultAbort) String ¶
func (x *FaultAbort) String() string
func (*FaultAbort) Validate ¶
func (m *FaultAbort) Validate() error
Validate checks the field values on FaultAbort 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 (*FaultAbort) ValidateAll ¶ added in v0.10.0
func (m *FaultAbort) ValidateAll() error
ValidateAll checks the field values on FaultAbort 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 FaultAbortMultiError, or nil if none found.
type FaultAbortMultiError ¶ added in v0.10.0
type FaultAbortMultiError []error
FaultAbortMultiError is an error wrapping multiple validation errors returned by FaultAbort.ValidateAll() if the designated constraints aren't met.
func (FaultAbortMultiError) AllErrors ¶ added in v0.10.0
func (m FaultAbortMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FaultAbortMultiError) Error ¶ added in v0.10.0
func (m FaultAbortMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FaultAbortValidationError ¶
type FaultAbortValidationError struct {
// contains filtered or unexported fields
}
FaultAbortValidationError is the validation error returned by FaultAbort.Validate if the designated constraints aren't met.
func (FaultAbortValidationError) Cause ¶
func (e FaultAbortValidationError) Cause() error
Cause function returns cause value.
func (FaultAbortValidationError) Error ¶
func (e FaultAbortValidationError) Error() string
Error satisfies the builtin error interface
func (FaultAbortValidationError) ErrorName ¶
func (e FaultAbortValidationError) ErrorName() string
ErrorName returns error name.
func (FaultAbortValidationError) Field ¶
func (e FaultAbortValidationError) Field() string
Field function returns field value.
func (FaultAbortValidationError) Key ¶
func (e FaultAbortValidationError) Key() bool
Key function returns key value.
func (FaultAbortValidationError) Reason ¶
func (e FaultAbortValidationError) Reason() string
Reason function returns reason value.
type FaultAbort_GrpcStatus ¶ added in v0.9.6
type FaultAbort_GrpcStatus struct { // gRPC status code to use to abort the gRPC request. GrpcStatus uint32 `protobuf:"varint,5,opt,name=grpc_status,json=grpcStatus,proto3,oneof"` }
type FaultAbort_HeaderAbort ¶ added in v0.9.5
type FaultAbort_HeaderAbort struct {
// contains filtered or unexported fields
}
Fault aborts are controlled via an HTTP header (if applicable). See the :ref:`HTTP fault filter <config_http_filters_fault_injection_http_header>` documentation for more information.
func (*FaultAbort_HeaderAbort) Descriptor
deprecated
added in
v0.9.5
func (*FaultAbort_HeaderAbort) Descriptor() ([]byte, []int)
Deprecated: Use FaultAbort_HeaderAbort.ProtoReflect.Descriptor instead.
func (*FaultAbort_HeaderAbort) ProtoMessage ¶ added in v0.9.5
func (*FaultAbort_HeaderAbort) ProtoMessage()
func (*FaultAbort_HeaderAbort) ProtoReflect ¶ added in v0.9.6
func (x *FaultAbort_HeaderAbort) ProtoReflect() protoreflect.Message
func (*FaultAbort_HeaderAbort) Reset ¶ added in v0.9.5
func (x *FaultAbort_HeaderAbort) Reset()
func (*FaultAbort_HeaderAbort) String ¶ added in v0.9.5
func (x *FaultAbort_HeaderAbort) String() string
func (*FaultAbort_HeaderAbort) Validate ¶ added in v0.9.5
func (m *FaultAbort_HeaderAbort) Validate() error
Validate checks the field values on FaultAbort_HeaderAbort 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 (*FaultAbort_HeaderAbort) ValidateAll ¶ added in v0.10.0
func (m *FaultAbort_HeaderAbort) ValidateAll() error
ValidateAll checks the field values on FaultAbort_HeaderAbort 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 FaultAbort_HeaderAbortMultiError, or nil if none found.
type FaultAbort_HeaderAbortMultiError ¶ added in v0.10.0
type FaultAbort_HeaderAbortMultiError []error
FaultAbort_HeaderAbortMultiError is an error wrapping multiple validation errors returned by FaultAbort_HeaderAbort.ValidateAll() if the designated constraints aren't met.
func (FaultAbort_HeaderAbortMultiError) AllErrors ¶ added in v0.10.0
func (m FaultAbort_HeaderAbortMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FaultAbort_HeaderAbortMultiError) Error ¶ added in v0.10.0
func (m FaultAbort_HeaderAbortMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FaultAbort_HeaderAbortValidationError ¶ added in v0.9.5
type FaultAbort_HeaderAbortValidationError struct {
// contains filtered or unexported fields
}
FaultAbort_HeaderAbortValidationError is the validation error returned by FaultAbort_HeaderAbort.Validate if the designated constraints aren't met.
func (FaultAbort_HeaderAbortValidationError) Cause ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) Cause() error
Cause function returns cause value.
func (FaultAbort_HeaderAbortValidationError) Error ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) Error() string
Error satisfies the builtin error interface
func (FaultAbort_HeaderAbortValidationError) ErrorName ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) ErrorName() string
ErrorName returns error name.
func (FaultAbort_HeaderAbortValidationError) Field ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) Field() string
Field function returns field value.
func (FaultAbort_HeaderAbortValidationError) Key ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) Key() bool
Key function returns key value.
func (FaultAbort_HeaderAbortValidationError) Reason ¶ added in v0.9.5
func (e FaultAbort_HeaderAbortValidationError) Reason() string
Reason function returns reason value.
type FaultAbort_HeaderAbort_ ¶ added in v0.9.5
type FaultAbort_HeaderAbort_ struct { // Fault aborts are controlled via an HTTP header (if applicable). HeaderAbort *FaultAbort_HeaderAbort `protobuf:"bytes,4,opt,name=header_abort,json=headerAbort,proto3,oneof"` }
type FaultAbort_HttpStatus ¶
type FaultAbort_HttpStatus struct { // HTTP status code to use to abort the HTTP request. HttpStatus uint32 `protobuf:"varint,2,opt,name=http_status,json=httpStatus,proto3,oneof"` }
type HTTPFault ¶
type HTTPFault struct { // If specified, the filter will inject delays based on the values in the // object. Delay *v31.FaultDelay `protobuf:"bytes,1,opt,name=delay,proto3" json:"delay,omitempty"` // If specified, the filter will abort requests based on the values in // the object. At least *abort* or *delay* must be specified. Abort *FaultAbort `protobuf:"bytes,2,opt,name=abort,proto3" json:"abort,omitempty"` // Specifies the name of the (destination) upstream cluster that the // filter should match on. Fault injection will be restricted to requests // bound to the specific upstream cluster. UpstreamCluster string `protobuf:"bytes,3,opt,name=upstream_cluster,json=upstreamCluster,proto3" json:"upstream_cluster,omitempty"` // Specifies a set of headers that the filter should match on. The fault // injection filter can be applied selectively to requests that match a set of // headers specified in the fault filter config. The chances of actual fault // injection further depend on the value of the :ref:`percentage // <envoy_v3_api_field_extensions.filters.http.fault.v3.FaultAbort.percentage>` field. // The filter will check the request's headers against all the specified // headers in the filter config. A match will happen if all the headers in the // config are present in the request with the same values (or based on // presence if the *value* field is not in the config). Headers []*v32.HeaderMatcher `protobuf:"bytes,4,rep,name=headers,proto3" json:"headers,omitempty"` // Faults are injected for the specified list of downstream hosts. If this // setting is not set, faults are injected for all downstream nodes. // Downstream node name is taken from :ref:`the HTTP // x-envoy-downstream-service-node // <config_http_conn_man_headers_downstream-service-node>` header and compared // against downstream_nodes list. DownstreamNodes []string `protobuf:"bytes,5,rep,name=downstream_nodes,json=downstreamNodes,proto3" json:"downstream_nodes,omitempty"` // The maximum number of faults that can be active at a single time via the configured fault // filter. Note that because this setting can be overridden at the route level, it's possible // for the number of active faults to be greater than this value (if injected via a different // route). If not specified, defaults to unlimited. This setting can be overridden via // `runtime <config_http_filters_fault_injection_runtime>` and any faults that are not injected // due to overflow will be indicated via the `faults_overflow // <config_http_filters_fault_injection_stats>` stat. // // .. attention:: // Like other :ref:`circuit breakers <arch_overview_circuit_break>` in Envoy, this is a fuzzy // limit. It's possible for the number of active faults to rise slightly above the configured // amount due to the implementation details. MaxActiveFaults *wrappers.UInt32Value `protobuf:"bytes,6,opt,name=max_active_faults,json=maxActiveFaults,proto3" json:"max_active_faults,omitempty"` // The response rate limit to be applied to the response body of the stream. When configured, // the percentage can be overridden by the :ref:`fault.http.rate_limit.response_percent // <config_http_filters_fault_injection_runtime>` runtime key. // // .. attention:: // This is a per-stream limit versus a connection level limit. This means that concurrent streams // will each get an independent limit. ResponseRateLimit *v31.FaultRateLimit `protobuf:"bytes,7,opt,name=response_rate_limit,json=responseRateLimit,proto3" json:"response_rate_limit,omitempty"` // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.delay.fixed_delay_percent DelayPercentRuntime string `protobuf:"bytes,8,opt,name=delay_percent_runtime,json=delayPercentRuntime,proto3" json:"delay_percent_runtime,omitempty"` // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.abort.abort_percent AbortPercentRuntime string `protobuf:"bytes,9,opt,name=abort_percent_runtime,json=abortPercentRuntime,proto3" json:"abort_percent_runtime,omitempty"` // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.delay.fixed_duration_ms DelayDurationRuntime string `protobuf:"bytes,10,opt,name=delay_duration_runtime,json=delayDurationRuntime,proto3" json:"delay_duration_runtime,omitempty"` // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.abort.http_status AbortHttpStatusRuntime string `` /* 132-byte string literal not displayed */ // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.max_active_faults MaxActiveFaultsRuntime string `` /* 132-byte string literal not displayed */ // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.rate_limit.response_percent ResponseRateLimitPercentRuntime string `` /* 161-byte string literal not displayed */ // The runtime key to override the :ref:`default <config_http_filters_fault_injection_runtime>` // runtime. The default is: fault.http.abort.grpc_status AbortGrpcStatusRuntime string `` /* 132-byte string literal not displayed */ // To control whether stats storage is allocated dynamically for each downstream server. // If set to true, "x-envoy-downstream-service-cluster" field of header will be ignored by this filter. // If set to false, dynamic stats storage will be allocated for the downstream cluster name. // Default value is false. DisableDownstreamClusterStats bool `` /* 154-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 16]
func (*HTTPFault) Descriptor
deprecated
func (*HTTPFault) GetAbort ¶
func (x *HTTPFault) GetAbort() *FaultAbort
func (*HTTPFault) GetAbortGrpcStatusRuntime ¶ added in v0.9.6
func (*HTTPFault) GetAbortHttpStatusRuntime ¶
func (*HTTPFault) GetAbortPercentRuntime ¶
func (*HTTPFault) GetDelay ¶
func (x *HTTPFault) GetDelay() *v31.FaultDelay
func (*HTTPFault) GetDelayDurationRuntime ¶
func (*HTTPFault) GetDelayPercentRuntime ¶
func (*HTTPFault) GetDisableDownstreamClusterStats ¶ added in v0.9.9
func (*HTTPFault) GetDownstreamNodes ¶
func (*HTTPFault) GetHeaders ¶
func (x *HTTPFault) GetHeaders() []*v32.HeaderMatcher
func (*HTTPFault) GetMaxActiveFaults ¶
func (x *HTTPFault) GetMaxActiveFaults() *wrappers.UInt32Value
func (*HTTPFault) GetMaxActiveFaultsRuntime ¶
func (*HTTPFault) GetResponseRateLimit ¶
func (x *HTTPFault) GetResponseRateLimit() *v31.FaultRateLimit
func (*HTTPFault) GetResponseRateLimitPercentRuntime ¶
func (*HTTPFault) GetUpstreamCluster ¶
func (*HTTPFault) ProtoMessage ¶
func (*HTTPFault) ProtoMessage()
func (*HTTPFault) ProtoReflect ¶ added in v0.9.6
func (x *HTTPFault) ProtoReflect() protoreflect.Message
func (*HTTPFault) Validate ¶
Validate checks the field values on HTTPFault 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 (*HTTPFault) ValidateAll ¶ added in v0.10.0
ValidateAll checks the field values on HTTPFault 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 HTTPFaultMultiError, or nil if none found.
type HTTPFaultMultiError ¶ added in v0.10.0
type HTTPFaultMultiError []error
HTTPFaultMultiError is an error wrapping multiple validation errors returned by HTTPFault.ValidateAll() if the designated constraints aren't met.
func (HTTPFaultMultiError) AllErrors ¶ added in v0.10.0
func (m HTTPFaultMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (HTTPFaultMultiError) Error ¶ added in v0.10.0
func (m HTTPFaultMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type HTTPFaultValidationError ¶
type HTTPFaultValidationError struct {
// contains filtered or unexported fields
}
HTTPFaultValidationError is the validation error returned by HTTPFault.Validate if the designated constraints aren't met.
func (HTTPFaultValidationError) Cause ¶
func (e HTTPFaultValidationError) Cause() error
Cause function returns cause value.
func (HTTPFaultValidationError) Error ¶
func (e HTTPFaultValidationError) Error() string
Error satisfies the builtin error interface
func (HTTPFaultValidationError) ErrorName ¶
func (e HTTPFaultValidationError) ErrorName() string
ErrorName returns error name.
func (HTTPFaultValidationError) Field ¶
func (e HTTPFaultValidationError) Field() string
Field function returns field value.
func (HTTPFaultValidationError) Key ¶
func (e HTTPFaultValidationError) Key() bool
Key function returns key value.
func (HTTPFaultValidationError) Reason ¶
func (e HTTPFaultValidationError) Reason() string
Reason function returns reason value.