In Focus

Building API Gateway Using Ocelot In ASP.NET Core - QoS (Quality of Service)

In this article, we will discuss QoS (Quality of Service) module of Ocelot when build API Gateway.

Introduction

In the previous articles of this series, we discussed how to build the API Gateway in ASP.NET Core.

And in this article , we will discuss QoS (Quality of Service) module of Ocelot.

If you want to look at the previous articles of this series, please visit the links given below.

What is QoS? 

Quality of service is the ability to provide different priorities to different applications, users, or data flows, or to guarantee a certain level of performance to a data flow.

Ocelot uses Polly to achieve this job. And I will use version 4.0.0 of Ocelot to build the following sample.

Preparation

We need to create two projects and ensure that they can run well.

After run them up, we will add configuration of QoS to this route : http://localhost:9000/customers.

Add QoS In configuration.json

We only need to add a node named QoSOptions.

The QoSOptions node contains 3 important properties.
  1. ExceptionsAllowedBeforeBreaking
    This value must greater than 0. It means that the circuit breaker will break after a certain number of exceptions occur.

  2. DurationOfBreak
    This value specifies how long the circuit breaker will stay open after it is tripped. The unit of this value is milliseconds.

  3. TimeoutValue
    This value specifies that a request will automatically be timed out if it takes more than this value. The unit of this value is milliseconds as well.
Here is a sample that shows you how to configure it.
  1. {  
  2.     "DownstreamPathTemplate""/api/values",  
  3.     "DownstreamScheme""http",  
  4.     "DownstreamHostAndPorts": [  
  5.         {  
  6.         "Host""localhost",  
  7.         "Port": 9001  
  8.         }  
  9.     ],  
  10.     "UpstreamPathTemplate""/customers",  
  11.     "UpstreamHttpMethod": [ "Get" ],  
  12.     "QoSOptions": {  
  13.         "ExceptionsAllowedBeforeBreaking":2,  
  14.         "DurationOfBreak":5000,  
  15.         "TimeoutValue":2000  
  16.     }  
  17. }  
  18. //others.....  

The above configuration means that when we visit http://localhost:9000/customers:

If the server does not response for 2 seconds, it will throw a timeout exception.

If the server throws a second exception, the server will not be accessible for five seconds.

Note

There is another property of QoSOptions named TimeoutStrategy. The default value of this property is TimeoutStrategy.Pessimistic. However, at this time, we can not change this value yet.

For showing the result, I made some change on the APIService.
  1. private static int _count = 0;  
  2.   
  3. // GET api/values  
  4. [HttpGet]  
  5. public IEnumerable<string> Get()  
  6. {  
  7.     _count++;  
  8.     System.Console.WriteLine($"get...{_count}");  
  9.     if(_count <= 3)  
  10.     {  
  11.         Thread.Sleep(5000);  
  12.     }              
  13.     return new string[] { "value1""value2" };  
  14. }   
Let's take a look at the result of this:



When we visit the first time, it tells us that circuit is breaking for 5000 ms.

 

The second time it tells us that the circuit is open, and we can not visit the services for five seconds.



After five seconds, the service is accessible.

Now, we have finished the job.

Here is the source code you can find in my github page .
Summary

This article introduced how to use QoS module in Ocelot.

I hope this can help you!