Dapr provides a capability for defining and applying fault tolerance resiliency policies via a resiliency spec. Resiliency specs are saved in the same location as components specs and are applied when the Dapr sidecar starts. The sidecar determines how to apply resiliency policies to your Dapr API calls. In self-hosted mode, the resiliency spec must be named
resiliency.yaml. In Kubernetes Dapr finds the named resiliency specs used by your application. Within the resiliency spec, you can define policies for popular resiliency patterns, such as:
Policies can then be applied to targets, which include:
Additionally, resiliency policies can be scoped to specific apps.
Learn more about how to write resilient microservices with Dapr.
Resiliency policy structure
Below is the general structure of a resiliency policy:
apiVersion: dapr.io/v1alpha1 kind: Resiliency metadata: name: myresiliency scopes: # optionally scope the policy to specific apps spec: policies: timeouts: # timeout policy definitions retries: # retry policy definitions circuitBreakers: # circuit breaker policy definitions targets: apps: # apps and their applied policies here actors: # actor types and their applied policies here components: # components and their applied policies here
Complete example policy
apiVersion: dapr.io/v1alpha1 kind: Resiliency metadata: name: myresiliency # similar to subscription and configuration specs, scopes lists the Dapr App IDs that this # resiliency spec can be used by. scopes: - app1 - app2 spec: # policies is where timeouts, retries and circuit breaker policies are defined. # each is given a name so they can be referred to from the targets section in the resiliency spec. policies: # timeouts are simple named durations. timeouts: general: 5s important: 60s largeResponse: 10s # retries are named templates for retry configurations and are instantiated for life of the operation. retries: pubsubRetry: policy: constant duration: 5s maxRetries: 10 retryForever: policy: exponential maxInterval: 15s maxRetries: -1 # retry indefinitely important: policy: constant duration: 5s maxRetries: 30 someOperation: policy: exponential maxInterval: 15s largeResponse: policy: constant duration: 5s maxRetries: 3 # circuit breakers are automatically instantiated per component and app instance. # circuit breakers maintain counters that live as long as the Dapr sidecar is running. They are not persisted. circuitBreakers: simpleCB: maxRequests: 1 timeout: 30s trip: consecutiveFailures >= 5 pubsubCB: maxRequests: 1 interval: 8s timeout: 45s trip: consecutiveFailures > 8 # targets are what named policies are applied to. Dapr supports 3 target types - apps, components and actors targets: apps: appB: timeout: general retry: important # circuit breakers for services are scoped app instance. # when a breaker is tripped, that route is removed from load balancing for the configured `timeout` duration. circuitBreaker: simpleCB actors: myActorType: # custom Actor Type Name timeout: general retry: important # circuit breakers for actors are scoped by type, id, or both. # when a breaker is tripped, that type or id is removed from the placement table for the configured `timeout` duration. circuitBreaker: simpleCB circuitBreakerScope: both ## circuitBreakerCacheSize: 5000 components: # for state stores, policies apply to saving and retrieving state. statestore1: # any component name -- happens to be a state store here outbound: timeout: general retry: retryForever # circuit breakers for components are scoped per component configuration/instance. For example myRediscomponent. # when this breaker is tripped, all interaction to that component is prevented for the configured `timeout` duration. circuitBreaker: simpleCB pubsub1: # any component name -- happens to be a pubsub broker here outbound: retry: pubsubRetry circuitBreaker: pubsubCB pubsub2: # any component name -- happens to be another pubsub broker here outbound: retry: pubsubRetry circuitBreaker: pubsubCB inbound: # inbound only applies to delivery from sidecar to app timeout: general retry: important circuitBreaker: pubsubCB
Watch this video for how to use resiliency:
Learn more about resiliency policies and targets:
- Targets Try out one of the Resiliency quickstarts:
- Resiliency: Service-to-service
- Resiliency: State Management
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.