go-control-plane: github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/fault/v3 Index | Files

package envoy_extensions_filters_http_fault_v3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/fault/v3"

Index

Package Files

fault.pb.go fault.pb.validate.go

Variables

var File_envoy_extensions_filters_http_fault_v3_fault_proto protoreflect.FileDescriptor

type FaultAbort Uses

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 Uses

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

Deprecated: Use FaultAbort.ProtoReflect.Descriptor instead.

func (*FaultAbort) GetErrorType Uses

func (m *FaultAbort) GetErrorType() isFaultAbort_ErrorType

func (*FaultAbort) GetGrpcStatus Uses

func (x *FaultAbort) GetGrpcStatus() uint32

func (*FaultAbort) GetHeaderAbort Uses

func (x *FaultAbort) GetHeaderAbort() *FaultAbort_HeaderAbort

func (*FaultAbort) GetHttpStatus Uses

func (x *FaultAbort) GetHttpStatus() uint32

func (*FaultAbort) GetPercentage Uses

func (x *FaultAbort) GetPercentage() *v3.FractionalPercent

func (*FaultAbort) ProtoMessage Uses

func (*FaultAbort) ProtoMessage()

func (*FaultAbort) ProtoReflect Uses

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

func (*FaultAbort) Reset Uses

func (x *FaultAbort) Reset()

func (*FaultAbort) String Uses

func (x *FaultAbort) String() string

func (*FaultAbort) Validate Uses

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, an error is returned.

type FaultAbortValidationError Uses

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 Uses

func (e FaultAbortValidationError) Cause() error

Cause function returns cause value.

func (FaultAbortValidationError) Error Uses

func (e FaultAbortValidationError) Error() string

Error satisfies the builtin error interface

func (FaultAbortValidationError) ErrorName Uses

func (e FaultAbortValidationError) ErrorName() string

ErrorName returns error name.

func (FaultAbortValidationError) Field Uses

func (e FaultAbortValidationError) Field() string

Field function returns field value.

func (FaultAbortValidationError) Key Uses

func (e FaultAbortValidationError) Key() bool

Key function returns key value.

func (FaultAbortValidationError) Reason Uses

func (e FaultAbortValidationError) Reason() string

Reason function returns reason value.

type FaultAbort_GrpcStatus Uses

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 Uses

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 Uses

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

Deprecated: Use FaultAbort_HeaderAbort.ProtoReflect.Descriptor instead.

func (*FaultAbort_HeaderAbort) ProtoMessage Uses

func (*FaultAbort_HeaderAbort) ProtoMessage()

func (*FaultAbort_HeaderAbort) ProtoReflect Uses

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

func (*FaultAbort_HeaderAbort) Reset Uses

func (x *FaultAbort_HeaderAbort) Reset()

func (*FaultAbort_HeaderAbort) String Uses

func (x *FaultAbort_HeaderAbort) String() string

func (*FaultAbort_HeaderAbort) Validate Uses

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, an error is returned.

type FaultAbort_HeaderAbortValidationError Uses

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 Uses

func (e FaultAbort_HeaderAbortValidationError) Cause() error

Cause function returns cause value.

func (FaultAbort_HeaderAbortValidationError) Error Uses

func (e FaultAbort_HeaderAbortValidationError) Error() string

Error satisfies the builtin error interface

func (FaultAbort_HeaderAbortValidationError) ErrorName Uses

func (e FaultAbort_HeaderAbortValidationError) ErrorName() string

ErrorName returns error name.

func (FaultAbort_HeaderAbortValidationError) Field Uses

func (e FaultAbort_HeaderAbortValidationError) Field() string

Field function returns field value.

func (FaultAbort_HeaderAbortValidationError) Key Uses

func (e FaultAbort_HeaderAbortValidationError) Key() bool

Key function returns key value.

func (FaultAbort_HeaderAbortValidationError) Reason Uses

func (e FaultAbort_HeaderAbortValidationError) Reason() string

Reason function returns reason value.

type FaultAbort_HeaderAbort_ Uses

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 Uses

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 Uses

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_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 `protobuf:"bytes,11,opt,name=abort_http_status_runtime,json=abortHttpStatusRuntime,proto3" json:"abort_http_status_runtime,omitempty"`
    // 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 `protobuf:"bytes,12,opt,name=max_active_faults_runtime,json=maxActiveFaultsRuntime,proto3" json:"max_active_faults_runtime,omitempty"`
    // 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 `protobuf:"bytes,13,opt,name=response_rate_limit_percent_runtime,json=responseRateLimitPercentRuntime,proto3" json:"response_rate_limit_percent_runtime,omitempty"`
    // 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 `protobuf:"bytes,14,opt,name=abort_grpc_status_runtime,json=abortGrpcStatusRuntime,proto3" json:"abort_grpc_status_runtime,omitempty"`
    // contains filtered or unexported fields
}

[#next-free-field: 15]

func (*HTTPFault) Descriptor Uses

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

Deprecated: Use HTTPFault.ProtoReflect.Descriptor instead.

func (*HTTPFault) GetAbort Uses

func (x *HTTPFault) GetAbort() *FaultAbort

func (*HTTPFault) GetAbortGrpcStatusRuntime Uses

func (x *HTTPFault) GetAbortGrpcStatusRuntime() string

func (*HTTPFault) GetAbortHttpStatusRuntime Uses

func (x *HTTPFault) GetAbortHttpStatusRuntime() string

func (*HTTPFault) GetAbortPercentRuntime Uses

func (x *HTTPFault) GetAbortPercentRuntime() string

func (*HTTPFault) GetDelay Uses

func (x *HTTPFault) GetDelay() *v31.FaultDelay

func (*HTTPFault) GetDelayDurationRuntime Uses

func (x *HTTPFault) GetDelayDurationRuntime() string

func (*HTTPFault) GetDelayPercentRuntime Uses

func (x *HTTPFault) GetDelayPercentRuntime() string

func (*HTTPFault) GetDownstreamNodes Uses

func (x *HTTPFault) GetDownstreamNodes() []string

func (*HTTPFault) GetHeaders Uses

func (x *HTTPFault) GetHeaders() []*v32.HeaderMatcher

func (*HTTPFault) GetMaxActiveFaults Uses

func (x *HTTPFault) GetMaxActiveFaults() *wrappers.UInt32Value

func (*HTTPFault) GetMaxActiveFaultsRuntime Uses

func (x *HTTPFault) GetMaxActiveFaultsRuntime() string

func (*HTTPFault) GetResponseRateLimit Uses

func (x *HTTPFault) GetResponseRateLimit() *v31.FaultRateLimit

func (*HTTPFault) GetResponseRateLimitPercentRuntime Uses

func (x *HTTPFault) GetResponseRateLimitPercentRuntime() string

func (*HTTPFault) GetUpstreamCluster Uses

func (x *HTTPFault) GetUpstreamCluster() string

func (*HTTPFault) ProtoMessage Uses

func (*HTTPFault) ProtoMessage()

func (*HTTPFault) ProtoReflect Uses

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

func (*HTTPFault) Reset Uses

func (x *HTTPFault) Reset()

func (*HTTPFault) String Uses

func (x *HTTPFault) String() string

func (*HTTPFault) Validate Uses

func (m *HTTPFault) Validate() error

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

type HTTPFaultValidationError Uses

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 Uses

func (e HTTPFaultValidationError) Cause() error

Cause function returns cause value.

func (HTTPFaultValidationError) Error Uses

func (e HTTPFaultValidationError) Error() string

Error satisfies the builtin error interface

func (HTTPFaultValidationError) ErrorName Uses

func (e HTTPFaultValidationError) ErrorName() string

ErrorName returns error name.

func (HTTPFaultValidationError) Field Uses

func (e HTTPFaultValidationError) Field() string

Field function returns field value.

func (HTTPFaultValidationError) Key Uses

func (e HTTPFaultValidationError) Key() bool

Key function returns key value.

func (HTTPFaultValidationError) Reason Uses

func (e HTTPFaultValidationError) Reason() string

Reason function returns reason value.

Package envoy_extensions_filters_http_fault_v3 imports 22 packages (graph) and is imported by 13 packages. Updated 2021-01-08. Refresh now. Tools for package owners.