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 (8.0.123.58001), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.1 (8.0.123.58001), 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

Labels:

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

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.
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more