Skip to main content

Replacing EventCounters with the new Metrics API

If you've been using EventCounters for instrumenting your .NET applications, it's time to consider migrating to the newer System.Diagnostics.Metrics API. Based on the OpenTelemetry specification, the Metrics API offers a more modern, flexible, and standardized approach to application instrumentation.

Why migrate?

The Metrics API provides several advantages over EventCounters:

  • Industry Standard: Built on OpenTelemetry, ensuring compatibility with a wide ecosystem of monitoring tools
  • Better Performance: More efficient with lower overhead
  • Richer Functionality: Support for histograms, exemplars, and more sophisticated metric types
  • Improved API Design: Cleaner, more intuitive interface for defining and recording metrics
  • Better Tooling Support: Growing ecosystem support from APM vendors and monitoring solutions

Microsoft has indicated that EventCounters are in maintenance mode, with new development focused on the Metrics API.

So reasons enough to migrate our EventCounters to the new Metrics API. Let's go for it!

Our original EventCounters example

With EventCounters, you typically created an EventSource and used specialized counter types:

Migration guide

Step 1: Add the required package

While System.Diagnostics.Metrics is part of .NET 6+, you may want to add OpenTelemetry packages for collection:

dotnet add package OpenTelemetry.Exporter.Console
dotnet add package OpenTelemetry.Extensions.Hosting

Step 2: Create a meter

Replace your EventSource with a Meter. The meter name should follow reverse domain name notation:

Step 3: Map counter types

Here's how EventCounter types map to Metrics API instruments:

Event Counter type Metrics API equivalent Use case
Event Counter Counter<T> Monotonically increasing values (requests, errors)
PollingCounter ObservableGauge<T> Current value snapshots (queue length, active connections)
IncrementingEventCounter Counter<T> Cumulative totals
IncrementingPollingCounter ObservableCounter<T> Cumulative totals from callbacks

Step 4: Migrate counter definitions

Now we move the different event counter types over:

Step 5(optional): Add tags

One powerful feature of the Metrics API is built-in support for tags. This allows you to give extra context to a metric:

Remark: You can further improve the performance of tags by using the built-in source generators.

Step 6: Configure ServiceCollection

In your application startup inside  Program.cs for ASP.NET Core add the following configuration:

Final result

Here is how the complete class looks like after the migration:

More information

Source-generated metrics with strongly-typed tags - .NET | Microsoft Learn

Understanding different metric APIs - .NET | Microsoft Learn

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...
Read more

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more