fault_injection_policy.proto

Package : resilience.policy.gloo.solo.io

Top

fault_injection_policy.proto

Table of Contents

FaultInjectionPolicySpec

FaultInjectionPolicy is used to inject faults (latency and errors) into requests sent through the mesh. Fault specification is part of a VirtualService rule. Faults include aborting the Http request from downstream service, and/or delaying proxying of requests. A fault rule MUST HAVE delay or abort or both. FaultInjectionPolicies are applied at the Route level.

Field Type Label Description
applyToRoutes []common.gloo.solo.io.RouteSelector repeated select the routes where the policy will be applied if left empty, will apply to all routes in the workspace.
config resilience.policy.gloo.solo.io.FaultInjectionPolicySpec.Config The details of the fault injection policy to apply to the selected routes.

FaultInjectionPolicySpec.Config

Note:* Delay and abort faults are independent of one another, even if both are specified simultaneously.

Field Type Label Description
delay resilience.policy.gloo.solo.io.FaultInjectionPolicySpec.Config.Delay Indicate the amount of delay in seconds. The optional percentage field can be used to only delay a certain percentage of requests. If left unspecified, all request will be delayed.
abort resilience.policy.gloo.solo.io.FaultInjectionPolicySpec.Config.Abort Abort the request and return the specified error code back to traffic source.

FaultInjectionPolicySpec.Config.Abort

Abort Http request attempts and return error codes back to downstream service, giving the impression that the upstream service is faulty.

Field Type Label Description
httpStatus int32 Required. HTTP status code to use to abort the request.
percentage google.protobuf.DoubleValue Percentage of requests to be aborted. Values range between 0 and 100. If omitted all requests will be aborted.

FaultInjectionPolicySpec.Config.Delay

Delay requests before forwarding, emulating various failures such as network issues, overloaded upstream service, etc.

Field Type Label Description
fixedDelay google.protobuf.Duration Required. Add a delay of a fixed duration before sending the request. Format: 1h/1m/1s/1ms. MUST be >=1ms.
percentage google.protobuf.DoubleValue Percentage of requests on which the delay will be injected. Values range between 0 and 100. If omitted all requests will be delayed.

FaultInjectionPolicyStatus

reflects the status of the FaultInjectionPolicy

Field Type Label Description
global common.gloo.solo.io.GenericGlobalStatus
workspaces []resilience.policy.gloo.solo.io.FaultInjectionPolicyStatus.WorkspacesEntry repeated The status of the resource in each workspace that it exists in.
selectedRoutes []common.gloo.solo.io.RouteReference repeated Routes selected by the policy

FaultInjectionPolicyStatus.WorkspacesEntry

Field Type Label Description
key string
value common.gloo.solo.io.WorkspaceStatus