https://github.com/gravitee-io/gravitee-policy-circuit-breaker

Gravitee.io Policy - Circuit Breaker
https://github.com/gravitee-io/gravitee-policy-circuit-breaker

product-apim security-scan

Last synced: 10 days ago
JSON representation

Gravitee.io Policy - Circuit Breaker

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-policy-circuit-breaker
• Owner: gravitee-io
• License: apache-2.0
• Created: 2020-04-10T16:17:30.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T05:41:03.000Z (12 months ago)
• Last Synced: 2024-11-08T01:48:29.521Z (2 months ago)
• Topics: product-apim, security-scan
• Language: Java
• Size: 46.9 KB
• Stars: 0
• Watchers: 29
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
= Circuit Breaker policy

ifdef::env-github[]

image:https://img.shields.io/static/v1?label=Available%20at&message=Gravitee.io&color=1EC9D2["Gravitee.io", link="https://download.gravitee.io/#graviteeio-apim/plugins/policies/gravitee-policy-circuit-breaker/"]

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://github.com/gravitee-io/gravitee-policy-circuit-breaker /blob/master/LICENSE.txt"]

image:https://img.shields.io/badge/semantic--release-conventional%20commits-e10079?logo=semantic-release["Releases", link="https://github.com/gravitee-io/gravitee-policy-circuit-breaker/releases"]

image:https://circleci.com/gh/gravitee-io/gravitee-policy-circuit-breaker.svg?style=svg["CircleCI", link="https://circleci.com/gh/gravitee-io/gravitee-policy-circuit-breaker"]

endif::[]

== Phase

|===

|onRequest |onResponse

| X

|

|===

== Description

This policy allows to switch to another backend or making the call fails with a `503 Service Unavailable` in case of errors or latency. It is possible to configure errors and latency threshold rate to open the circuit breaker.

Implementation is based on Resilience4j, you can find more information on https://resilience4j.readme.io/docs/circuitbreaker[their documentation].

It guaranties high availability making your system resilient if your target is detected as failing.

== Compatibility with APIM

|===

|Plugin version | APIM version

|Up to 1.x                   | All

|===

== Configuration

You can configure the policy with the following options:

|===

|Property |Required |Description |Type |Default

|failureRateThreshold|X|Failure rate threshold before the circuit breaker switches to open state. A failure represents a response's status code >= 500. The threshold is expressed as a percentage.|integer (min. 0, max.100)|50

|slowCallRateThreshold|X|Slow call rate threshold before the circuit breaker switches to open state. A slow call is represented by a response time greater than the configured `slowCallDurationThreshold`. The threshold is expressed as a percentage.|integer (min. 0, max.100)|50

|slowCallDurationThreshold|X|The duration threshold above which a call is considered as slow, increasing `slowCallRateThreshold`. The duration is expressed in milliseconds.|integer (min. 1)|1000

|windowSize|X|The size of the sliding window which is used to record the outcome of calls when the circuit is closed.|integer (min. 0)|100

|waitDurationInOpenState||The duration in millisecond before switching from open circuit to half-open.|integer (min. 1)|1000

|redirectToURL||Redirect the call to the given URL instead of returning '503 Service Unavailable' status (supports EL)|string|

|scope|X|Cached response can be set for a single consumer (application) or for all applications.
WARNING: Please be aware that by using an \"API\" scope, data will be shared between all consumers !|API / APPLICATION|APPLICATION

|===