Tuning endpoint message processing

NServiceBus uses defaults that ensure good performance in common cases. While this is usually the preferred mode of operation there are situations where tuning might be desired.

Tuning concurrency

Limit maximum concurrency so that no more messages than the specified value are ever processed at the same time. If a maximum concurrency is not specified, the transport will choose an optimal value that is a balance between throughput and effective resource usage.

Sequential processing:

Set the concurrently limit value to 1 to process messages sequentially.

Examples where concurrency tuning might be relevant are:

• Non thread safe code that needs to run sequentially
• Databases that might deadlock when getting too many concurrent requests

Throttling

Limit the number of messages per second that the endpoint will process at any given time. This will help avoiding the endpoint from overloading sensitive resources that are using ressources like web-services, databases, other endpoints etc. Some examples would include

• An integration endpoint calling a web API, like api.github.com, that have restrictions on the number or requests per unit of time allowed.
• A firewall that, for flood protection, limits the number of connections per second and IP address.

By default no throughput restrictions will be enforced.

Configuration

The default limits of an endpoint can be changed in both code and via app.config.

Via a IConfigurationProvider

public class ProvideConfiguration :
    IProvideConfiguration<TransportConfig>
{
    public TransportConfig GetConfiguration()
    {
        return new TransportConfig
        {
            MaximumConcurrencyLevel = 5,
            MaximumMessageThroughputPerSecond = 10
        };
    }
}

Via app.config

By using raw xml.

<configSections>
  <section name="TransportConfig"
           type="NServiceBus.Config.TransportConfig, NServiceBus.Core"/>
</configSections>
<TransportConfig MaximumConcurrencyLevel="5"
                 MaximumMessageThroughputPerSecond="10"/>

Run time settings

Concurrency and throughput throttling to be changed and read at run time using the code below.

Optimizing at run time

var transport = unicastBus.Transport;
transport.ChangeMaximumMessageThroughputPerSecond(10);
transport.ChangeMaximumConcurrencyLevel(5);

Reading current values at run time

var transport = unicastBus.Transport;
var messageThroughputPerSecond = transport.MaximumMessageThroughputPerSecond;
var maximumConcurrencyLevel = transport.MaximumConcurrencyLevel;