Skip to main content

Monitor your application using Event Counters–Part I

I’m building a data pipeline using TPL Dataflow to migrate data from a database to an external API. As this data pipeline could run for a long time, I was looking for a good way to monitor the progress. This turned out to be a perfect use case for Event Counters.

What are EventCounters?

Here is what the documentation has to say about Event Counters:

EventCounters are .NET APIs used for lightweight, cross-platform, and near real-time performance metric collection. EventCounters were added as a cross-platform alternative to the "performance counters" of .NET Framework on Windows. EventCounters can be used to track various metrics.

And somewhat further in the documentation:

Apart from the EventCounters that are provided by the .NET runtime, you may choose to implement your own EventCounters.

And that is exactly what we are going to do!

Implement our first EventCounter

There are 4 types of counters that you can use each with their own characteristics and use cases:

We’ll start with a simple use case; with our first EventCounter we want to track the number of records that are migrated. So this should be an ever increasing number while the migration pipeline is running.

  • I start by creating a class that inherits from EventSource:
  • Next, we need to annotate this class with the [EventSource] attribute and specify a unique name:
  • We foresee a static instance of our class and a variable that can be used to track the number of migrated records:
  • For this use case, I start by using the PollingCounter and keep track of the value ourself. We create a new instance of the PollingCounter and foresee a callback method that will be used to read the counted value.
    • Notice that we are using Interlocked.Read() to guarantee thread-safety.
  • As we want to track the value ourself, we also need to provide a method to update the count.
    • Again, we are using an Interlocked.Add() to guarantee thread-safety.

This is what the end result looks like (I added some extra cleanup logic):

In the next post, we’ll have a look how we can consume the EventCounters data using some of the dotnet tools.

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