Polly icon indicating copy to clipboard operation
Polly copied to clipboard

Document bulkhead queue default behaviour

Open matthias-schuchardt opened this issue 5 years ago • 0 comments

Is your feature request related to a specific problem? Or an existing feature? Please describe.

I had a problem in understanding the default value of the queue-parameter of the bulkhead policy. I assumed that leaving it out would imply an infinite queue. However, just the opposite is the case. Without the queue-parameter set, it is set to 0 per default and thus load-shedding kicks in as soon as the maxParallelization-limit is reached.

Describe your proposed or preferred solution:

Can the default behaviour be documented in the xml-comments and the wiki of the bulkhead-policy more clearly? Especially the following points I would consider important.

  • When leaving out the maxQueuingActions-parameter, it defaults to 0.
  • This implies that an BulkheadRejectedException is thrown as soon as the limit set in maxParallelization is reached.

Any additional info?

This is not a deal breaker, but rather a speed bump when trying to understand how the bulkhead policy works. So one could also leave it as it is and have developers run into the exception.

matthias-schuchardt avatar Nov 20 '20 12:11 matthias-schuchardt