本文介紹Ocelot中的QoS(Quality of Service),其使用了Polly對超時等請求下游失敗等情況進行熔斷。
1、添加Nuget包
添加 Ocelot.Provider.Polly 到OcelotGetway項目中

nuget.png
2、修改 Startup.ConfigureServices 如下來添加Polly:
services
.AddOcelot(new ConfigurationBuilder()
.AddJsonFile("configuration.json")
.Build())
.AddConsul()
.AddPolly()
.AddCacheManager(x => x.WithDictionaryHandle())
.AddAdministration("/administration", "secret");
3、在WebApiA中添加一個SlowController,并添加如下代碼:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
namespace WebApiA.Controllers
{
public class SlowController : Controller
{
[Produces("application/json")]
[Route("api/[controller]/[action]")]
public async Task<string> GetName()
{
await Task.Delay(6000);
return "Jonathan";
}
}
}
其中 GetName 延時6秒返回。
4、在configuration.json的 ReRoutes 節(jié)點添加一個新的路由來訪問剛才添加的api方法
{
"DownstreamPathTemplate": "/api/Slow/GetName",
"DownstreamScheme": "http",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/GetName",
"UpstreamHttpMethod": [ "Get" ],
"QoSOptions": {
"ExceptionsAllowedBeforeBreaking":3,
"DurationOfBreak":60000,
"TimeoutValue": 1000
}
}
其中通過 QoSOptions 對該路由添加QoS,對其中的3個屬性解釋如下:
- ExceptionsAllowedBeforeBreaking:發(fā)生幾次請求異常(比如超時)后進行熔斷,該值必須大于0
- DurationOfBreak:熔斷時間(單位:毫秒)
- TimeoutValue:下游請求超時時間(單位:毫秒,默認(rèn)90秒)
用一句話描述上述配置:對http://localhost:5001/api/Slow/GetName請求超過1s將會超時,發(fā)生三次超時后保持60s熔斷。
運行WebApiA與OcelotGetway項目,然后請求http://localhost:5000/GetName多次:
QoS.GetName.gif
可以看到在前3次請求,Time在1000ms之后返回503,在第四次以后發(fā)生熔斷,請求后立即(Time在100ms左右)返回503。
官方文檔中說可以只配置TimeoutValue而不配置其它兩個來達(dá)到修改超時時間的功能,如下:
"QoSOptions": {
"TimeoutValue":5000
}
該配置存在bug,因為如上配置 ExceptionsAllowedBeforeBreaking 將會為0,將會觸發(fā)Polly配置異常,我已經(jīng)向Ocelot提交了一個Pull Request來修復(fù)該問題,并且已經(jīng)被合并到主分支中,預(yù)計在下一個版本中該問題將不會存在。
如果你現(xiàn)在想修改超時時間,但是又不想使用熔斷,可以配置如下:
"QoSOptions": {
"ExceptionsAllowedBeforeBreaking":10000,
"DurationOfBreak": 1,
"TimeoutValue": 1000
}
在發(fā)生很多次異常才會進行熔斷,并且立即從熔斷中恢復(fù)。
源碼下載
