Simulating Latency and Bandwidth Restrictions in WCF

If you're developing WCF applications that will run over a WAN, VPN, or the public internet, then network bandwidth and latency is a concern. Messages take longer to transmit over these networks than over your local area network (LAN). As such, part of your development and testing needs to include testing the application over these typed of "slower" connection.

To perform this testing there are two main options:  have a connection at your disposal, or simulate one.  Most of us will probably have to simulate one.  There are a few projects out there that are basically bridges, typically linux based, that you put between your client and server that allow you to simulate these slower connections. If you are a Java developer, you're probably familiar with JMeter. JMeter's approach doesn't involve a bridge, but rather simulates the latency at the client.

I was chatting with Peter Lin, a friend, colleague, and JMeter committer, about it one night. After he mentioned how JMeter simulated latency and low bandwidth, I decided to create a simulator based on JMeter's thread sleep concept at the client leveraging WCF's extensibility though behaviors and inspectors. The result is an open source project aptly named "WCF Latency Simulator".


As you can see, the UI is very simplistic. It allows you to set the latency in milliseconds and the bandwidth in bits per second. More importantly, it's on-the-fly. You can turn these knobs while your application is running and the new settings will be picked up without having to restart your application.

Side note: It's a .Net application, I promise. The windowing is a skin provided by Parallels so my Windows apps are fit in more seamless with my Mac :)
It's fairly easy to plug it into your application. You need to reference the MilestonTG.WcfLatencySimulator.Wcf.dll library in your client application. When you create the instance of your client proxy (I always recommend this be done with a factory), simply add the MilestoneTG.WcfLatencySimulator.Wcf.SimulatorClientBehavior end point behavior to the endpoint:
client.Endpoint.Behaviors.Add(new SimulatorClientBehavior());

Start the simulator UI, dial in your settings, and fire up your application. The behavior communicates with the simulator using named pipes, so it's important that the simulator be running before you launch your application. As a future enhancement, I'll fix it so the order doesn't matter, but for now, simulator first, your application second.

Custom Providers

One of the components of this tool is the settings provider. This is where the simulator gets it's settings from. You can use the simulator through the API by referencing the singleton: MilestoneTG.WcfLatencySimulator.Library.Simulator found in the MilestoneTG.WcfLatencySimulator.Library.dll assembly. The Simulator Class has the method SetProvider() that accepts an ISettingsProvider as a parameter. This interface contains only one method, GetSettings() that returns a MilestoneTG.WcfLatencySimulator.Wcf.LatencySettings object.


   1:  namespace MilestoneTG.WcfLatencySimulator.Library
   2:  {
   3:      /// <summary>
   4:      /// This interface must be implemented by all settings providers.  The simulator uses the this interface to retreive the
   5:      /// settings from the provider.
   6:      /// </summary>
   7:      public interface ISettingsProvider
   8:      {
   9:          /// <summary>
  10:          /// When implemented, returns the LegacySettings supplied by the implementing class.
  11:          /// </summary>
  12:          /// <returns></returns>
  13:          LatencySettings GetSettings();
  14:      }
  15:  }

A provider then, might look like:

   1:      public class SettingsProvider : ISettingsProvider
   2:      {
   3:          #region ISettingsView Members
   4:   
   5:          public LatencySettings GetSettings()
   6:          {
   7:              return new LatencySettings() { Latency = (int)_latencySpinner.Value, Bandwidth = (long)_bandwidthSpinner.Value };
   8:          }
   9:   
  10:          #endregion
  11:   
  12:      }

To use your custom provider:
   1:  SettingsProvider _settingsProvider = new SettingsProvider();
   2:   
   3:  Simulator.Instance.SetProvider(_settingsProvider);
   4:   
   5:  Simulator.Instance.Start();

The Project

You can find the project on Milestone's web site at: http://www.milestonetg.com/products/54-wcf-latency-simulator Both the binaries and the source code is available and distributed under the Apache2 license.

I hope you find this tool useful.  Please feel free to drop a comment; I'd like to hear your ideas for additional features/functionality.

Comments

Post a Comment

Popular posts from this blog

Using NHibernate in Asp.Net Core

Starting with version 5.1, NHibernate now supports .Net Core and .Netstandard as well as the full framework. Let’s take a quick look at how to set it up in an ASP.Net Core 2.x/3.x application. Configuration As of this writing, NHibernate doesn’t support the configuration system within Asp.Net Core based on Microsoft.Extensions.Configuration. The good news is, you don’t have to use a  hibernate.cfg.xml  file or the   section in app.config. You can add the properies manually, and pull the values from Asp.Net Core’s configuration, taking advantage of all the goodies that come with it. This opens up a world of configuration deployment possibilities. var config = new Configuration (); IDictionary < string , string > properties = new Dictionary < string , string > { { "connection.connection_string" , Configuration . GetConnectionString ( "Default" ) }, { "dialect" , "NHibernate.Dialect.SQLiteDialect" }, ...
Read more

Adding New Microsoft Extensions to Legacy WCF and ASMX Web Services

I was asked by several people recently: Can I use dependency injection with my legacy WCF and ASMX web services? Microsoft has some new stuff they released with core–specifically, a new configuration system, caching, and logging providers. Can I use them in my legacy WCF and ASMX web services? The answer to both is yes you can! In fact, I recommend it! To illustrate this, we’ll take a look at taking a sample application that has a WCF service and a ASMX service and we’ll: Add dependency injection using Ninject. Add the new Configuration provider from the new  Microsoft.Extensions.Configuration  packages. Add caching functionality using Microsoft’s new  Microsoft.Extensions.Caching  packages. Use the new logging providers from  Microsoft.Extensions.Logging  packages. Dependency Injection We use Ninject, but you can just as easily use AutoFac or SimpleInjector as they also have packaged integrations for WCF. You can use other containers, bu...
Read more

Code Coverage for Multiple Projects in a Single Build using Dotnet Test and Coverlet

Most of the time, your solution will have more than one project and a test unit project for each of those. Azure DevOps only, as of this writing, only allows you to update a single code coverage summary. If you upload more than one, each overwrites the next and only the last one remains. To accomplish this, we can use the merge functionality in Coverlet . I use the MSBuild extension, because it is better suited for CI pipelines. In your test project XML, add the package... <PackageReference Include="coverlet.msbuild" Version="2.7.0">     <PrivateAssets>all</PrivateAssets>     <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference> Then, in your dotnet test command or msbuild command, tell it to use Coverlet and to merge results. If you're using Azure DevOps, your test task looks this... (line wrapped for read ability in the article) - task: DotNetCoreCLI@2 displayName: Test i...
Read more