Skip to content

Add circuit breaker to the backend contract #21320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
live1206 merged 5 commits into from
Nov 11, 2022
Merged

Add circuit breaker to the backend contract #21320

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
baebd3d
add circuit breaker to the backend contract
m-h-s Oct 27, 2022
e683099
resolve validation errors
m-h-s Oct 31, 2022
763188d
Revert "resolve validation errors" and last push
m-h-s Oct 31, 2022
469e83b
resolve validation errors
m-h-s Oct 31, 2022
5cb8f0d
run prettier
m-h-s Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions ...ment/resource-manager/Microsoft.ApiManagement/preview/2022-09-01-preview/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1831,6 +1831,10 @@
"tls": {
"$ref": "#/definitions/BackendTlsProperties",
"description": "Backend TLS Properties"
},
"circuitBreaker": {
"$ref": "#/definitions/BackendCircuitBreaker",
"description": "Backend Circuit Breaker Configuration"
}
},
"description": "Backend entity base Parameter set."
Expand Down Expand Up @@ -2126,6 +2130,100 @@
},
"description": "Backend update parameters."
},
"BackendCircuitBreaker": {
"type": "object",
"description": "The configuration of the backend circuit breaker",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/CircuitBreakerRule"
},
"maxItems": 15,
"description": "The rules for tripping the backend.",
"x-ms-identifiers": []
Copy link
Member

@rkmanda rkmanda Nov 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[]

include the property set that uniquely identifies a single element in the array

}
}
},
"CircuitBreakerRule": {
"type": "object",
"description": "Rule configuration to trip the backend.",
"properties": {
"name": {
"type": "string",
"description": "The rule name."
},
"failureCondition": {
"$ref": "#/definitions/CircuitBreakerFailureCondition",
"description": "The conditions for tripping the circuit breaker."
},
"tripDuration": {
"type": "string",
"format": "duration",
"description": "The duration for which the circuit will be tripped."
}
}
},
"CircuitBreakerFailureCondition": {
"type": "object",
"description": "The trip conditions of the circuit breaker",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"description": "The threshold for opening the circuit."
},
"percentage": {
"type": "integer",
"format": "int64",
"description": "The threshold for opening the circuit."
},
"interval": {
"type": "string",
"format": "duration",
"description": "The interval during which the failures are counted."
},
"statusCodeRanges": {
"type": "array",
"items": {
"$ref": "#/definitions/FailureStatusCodeRange"
},
"maxItems": 10,
"description": "The status code ranges which are considered as failure.",
"x-ms-identifiers": []
},
"errorReasons": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200
},
"maxItems": 10,
"description": "The error reasons which are considered as failure.",
"x-ms-identifiers": []
}
}
},
"FailureStatusCodeRange": {
"type": "object",
"description": "The failure http status code range",
"properties": {
"min": {
"type": "integer",
"format": "int32",
"description": "The minimum http status code.",
"minimum": 200,
"maximum": 599
},
"max": {
"type": "integer",
"format": "int32",
"description": "The maximum http status code.",
"minimum": 200,
"maximum": 599
}
}
},
"BearerTokenSendingMethodsContract": {
"type": "string",
"description": "Form of an authorization grant, which the client uses to request the access token.",
Expand Down