Renaming http throttle settings

Author: mathewc

sample/host.json

@@ -5,8 +5,8 @@
     },
     "http": {
         "routePrefix": "api",
-        "maxDegreeOfParallelism": 5,
-        "maxQueueLength": 30
+        "maxConcurrentRequests": 5,
+        "maxOutstandingRequests": 30
     },
     "tracing": {
         "fileLoggingMode": "always"

schemas/json/host.json

@@ -45,13 +45,13 @@
                     "type": "string",
                     "default": "api"
                 },
-                "maxDegreeOfParallelism": {
+                "maxConcurrentRequests": {
                     "description": "Defines the the maximum number of http functions that will execute in parallel.",
                     "type": "integer",
                     "default": -1
                 },
-                "maxQueueLength": {
-                    "description": "Defines the maximum number of pending requests that will be queued for processing.",
+                "maxOutstandingRequests": {
+                    "description": "Defines the maximum number of oustanding requests that will be held at any given time.",
                     "type": "integer",
                     "default": -1
                 },

src/WebJobs.Script/Binding/Http/HttpConfiguration.cs

@@ -9,8 +9,8 @@ public class HttpConfiguration
     {
         public HttpConfiguration()
         {
-            MaxQueueLength = DataflowBlockOptions.Unbounded;
-            MaxDegreeOfParallelism = DataflowBlockOptions.Unbounded;
+            MaxOutstandingRequests = DataflowBlockOptions.Unbounded;
+            MaxConcurrentRequests = DataflowBlockOptions.Unbounded;
             RoutePrefix = ScriptConstants.DefaultHttpRoutePrefix;
         }
 
@@ -21,17 +21,19 @@ public HttpConfiguration()
         public string RoutePrefix { get; set; }
 
         /// <summary>
-        /// Gets or sets the maximum number of pending requests that
-        /// will be queued for processing. If this limit is exceeded,
-        /// new requests will be rejected with a 429 status code.
+        /// Gets or sets the maximum number of outstanding requests that
+        /// will be held at any given time. This limit includes requests
+        /// that have started executing, as well as requests that have
+        /// not yet started executing.
+        /// If this limit is exceeded, new requests will be rejected with a 429 status code.
         /// </summary>
-        public int MaxQueueLength { get; set; }
+        public int MaxOutstandingRequests { get; set; }
 
         /// <summary>
-        /// Gets or sets the maximum number of http functions that will execute
-        /// in parallel.
+        /// Gets or sets the maximum number of http functions that will
+        /// be allowed to execute in parallel.
         /// </summary>
-        public int MaxDegreeOfParallelism { get; set; }
+        public int MaxConcurrentRequests { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether dynamic host counter

src/WebJobs.Script/Binding/Http/HttpRequestManager.cs

@@ -23,8 +23,8 @@ public HttpRequestManager(HttpConfiguration httpConfiguration, TraceWriter trace
             Config = httpConfiguration;
             TraceWriter = traceWriter;
 
-            if (Config.MaxQueueLength != DataflowBlockOptions.Unbounded ||
-                Config.MaxDegreeOfParallelism != DataflowBlockOptions.Unbounded)
+            if (Config.MaxOutstandingRequests != DataflowBlockOptions.Unbounded ||
+                Config.MaxConcurrentRequests != DataflowBlockOptions.Unbounded)
             {
                 InitializeRequestQueue();
             }
@@ -58,7 +58,7 @@ public async Task<HttpResponseMessage> ProcessRequestAsync(HttpRequestMessage re
                 }
                 else
                 {
-                    TraceWriter.Info($"Http request queue limit of {Config.MaxQueueLength} has been exceeded.");
+                    TraceWriter.Info($"Http request queue limit of {Config.MaxOutstandingRequests} has been exceeded.");
                     return RejectRequest(request);
                 }
             }
@@ -95,8 +95,8 @@ private void InitializeRequestQueue()
         {
             var options = new ExecutionDataflowBlockOptions
             {
-                MaxDegreeOfParallelism = Config.MaxDegreeOfParallelism,
-                BoundedCapacity = Config.MaxQueueLength
+                MaxDegreeOfParallelism = Config.MaxConcurrentRequests,
+                BoundedCapacity = Config.MaxOutstandingRequests
             };
 
             _requestQueue = new ActionBlock<HttpRequestItem>(async item =>

test/WebJobs.Script.Tests/Binding/HttpRequestManagerTests.cs

@@ -34,8 +34,8 @@ public async Task ProcessRequest_PropigatesExceptions()
             };
             var config = new HttpConfiguration
             {
-                MaxQueueLength = 10,
-                MaxDegreeOfParallelism = 5
+                MaxOutstandingRequests = 10,
+                MaxConcurrentRequests = 5
             };
             var manager = new HttpRequestManager(config, _traceWriter);
 
@@ -83,7 +83,7 @@ public async Task ProcessRequest_MaxParallelism_RequestsAreThrottled()
             };
             var config = new HttpConfiguration
             {
-                MaxDegreeOfParallelism = maxParallelism
+                MaxConcurrentRequests = maxParallelism
             };
             var manager = new HttpRequestManager(config, _traceWriter);
 
@@ -99,7 +99,7 @@ public async Task ProcessRequest_MaxParallelism_RequestsAreThrottled()
         }
 
         [Fact]
-        public async Task ProcessRequest_MaxQueueLength_RequestsAreRejected()
+        public async Task ProcessRequest_MaxOutstandingRequestsExceeded_RequestsAreRejected()
         {
             int maxQueueLength = 10;
             Func<HttpRequestMessage, CancellationToken, Task<HttpResponseMessage>> process = async (req, ct) =>
@@ -109,8 +109,8 @@ public async Task ProcessRequest_MaxQueueLength_RequestsAreRejected()
             };
             var config = new HttpConfiguration
             {
-                MaxQueueLength = maxQueueLength,
-                MaxDegreeOfParallelism = 1
+                MaxOutstandingRequests = maxQueueLength,
+                MaxConcurrentRequests = 1
             };
             var manager = new HttpRequestManager(config, _traceWriter);
 

test/WebJobs.Script.Tests/ScriptHostTests.cs

@@ -539,20 +539,20 @@ public void ApplyConfiguration_Http()
 
             Assert.Equal(ScriptConstants.DefaultHttpRoutePrefix, scriptConfig.HttpConfiguration.RoutePrefix);
             Assert.Equal(false, scriptConfig.HttpConfiguration.DynamicThrottlesEnabled);
-            Assert.Equal(scriptConfig.HttpConfiguration.MaxDegreeOfParallelism, DataflowBlockOptions.Unbounded);
-            Assert.Equal(scriptConfig.HttpConfiguration.MaxQueueLength, DataflowBlockOptions.Unbounded);
+            Assert.Equal(scriptConfig.HttpConfiguration.MaxConcurrentRequests, DataflowBlockOptions.Unbounded);
+            Assert.Equal(scriptConfig.HttpConfiguration.MaxOutstandingRequests, DataflowBlockOptions.Unbounded);
 
             http["routePrefix"] = "myprefix";
             http["dynamicThrottlesEnabled"] = true;
-            http["maxDegreeOfParallelism"] = 5;
-            http["maxQueueLength"] = 10;
+            http["maxConcurrentRequests"] = 5;
+            http["maxOutstandingRequests"] = 10;
 
             ScriptHost.ApplyConfiguration(config, scriptConfig);
 
             Assert.Equal("myprefix", scriptConfig.HttpConfiguration.RoutePrefix);
             Assert.Equal(true, scriptConfig.HttpConfiguration.DynamicThrottlesEnabled);
-            Assert.Equal(scriptConfig.HttpConfiguration.MaxDegreeOfParallelism, 5);
-            Assert.Equal(scriptConfig.HttpConfiguration.MaxQueueLength, 10);
+            Assert.Equal(scriptConfig.HttpConfiguration.MaxConcurrentRequests, 5);
+            Assert.Equal(scriptConfig.HttpConfiguration.MaxOutstandingRequests, 10);
         }
 
         // with swagger with setting name with value