Skip to main content

Using parameters in BenchmarkDotNet

Most of the code I write is library code aimed to help other developers be more productive. As a consequence, a lot of this code is part of the critical path of an application and is execute a lot. This means that performance is critical. To measure the impact of a code change, I like to use BenchmarkDotNet, a powerful library for benchmarking .NET code.

When of the benchmark tests I got was to compare the impact between logging enabled and disabled.

I removed most the implementation in the code above but what is important is that the implementation of both benchmark methods was completely the same with only the addition of an EnableLogging() call as a difference.

An alternative(read better) way to implement this, is by using parameters. I added an extra property IsLoggingEnabled and specified the values using the [Params] attribute:

The benchmark is run for every combination of parameters you’ve provided and nicely visualized in the results:

// * Summary *

BenchmarkDotNet v0.13.10, Windows 10 (10.0.19044.4046/21H2/November2021Update) (Hyper-V)
Intel Xeon Gold 6154 CPU 3.00GHz, 1 CPU, 4 logical and 4 physical cores
.NET SDK 8.0.101
  [Host]     : .NET 8.0.1 (, X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.1 (, X64 RyuJIT AVX2

| Method      | IsLoggingEnabled | Mean      | Error     | StdDev     | Gen0       | Gen1     | Allocated |
|------------ |----------------- |----------:|----------:|-----------:|-----------:|---------:|----------:|
| GetProducts | False            |  91.78 ms |  1.830 ms |   3.481 ms |   750.0000 | 250.0000 |   9.65 MB |
| GetProducts | True             | 345.69 ms | 58.352 ms | 172.051 ms | 29333.3333 |        - | 362.61 MB |

If you need more values or want to generate them dynamically, you can also use [ParamsSource]. You need to specify the name of a public method or property that provides the values (implementing IEnumerable). The source must be within the benchmarked type:

More information

Parameterization | BenchmarkDotNet

Popular posts from this blog

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Color B

Help! I accidently enabled HSTS–on localhost

I ran into an issue after accidently enabling HSTS for a website on localhost. This was not an issue for the original website that was running in IIS and had a certificate configured. But when I tried to run an Angular app a little bit later on http://localhost:4200 the browser redirected me immediately to https://localhost . Whoops! That was not what I wanted in this case. To fix it, you need to go the network settings of your browser, there are available at: chrome://net-internals/#hsts edge://net-internals/#hsts brave://net-internals/#hsts Enter ‘localhost’ in the domain textbox under the Delete domain security policies section and hit Delete . That should do the trick…

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.