Skip to main content

Azure Application Insights Logging and EF Core in a Domain Driven Design

Logging is one of the core pillars of application development. .NET Core has fantastic support for rich contextual logging which spans across distributed system using its Activity API. Azure Application Insights SDK offers extensive logging out of the box without writing a single line of code. Just wire up the SDK and you are good to go. However there may be situations where you may want more fine grained control over the logging experience. Fortunately, its as simple as writing:

Activity activity = new Activity("Test Message");
var operation = telemetryClient.StartOperation<DependencyTelemetry>(activity);

This TelemetryClient is injected in your application when you wire up Application Insights.

services.AddApplicationInsightsTelemetry(options => options.InstrumentationKey = "YOUR_AI_KEY");

This works seamlessly till you hit the road block of Domain Driven Design and Entity Framework Core. In DDD, entities represent a real-world business object and performs equivalent operations. To use these objects with EF Core, they must have a parameter-less public constructor. So how will we inject our TelemetryClient?

Fortunately EF Core allows injecting DbContext in entity classes. So in the highly contrived example in the linked Github repository, you can create a public property for TelemetryClient in your DbContext class.

public class SchoolContext : DbContext
        public TelemetryClient AppInsightsClient { get; }
        public DbSet<Student> Students { get; set; }
        public DbSet<Course> Courses { get; set; }

        public SchoolContext(TelemetryClient telemetryClient)
            this.AppInsightsClient = telemetryClient;

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)

Now this telemetry client can be accessed in your entity classes like this:

public class Student
        private readonly TelemetryClient telemetryClient;
        public int StudentId { get; set; }
        public string Name { get; set; }

        public Student()


        public Student(TelemetryClient client)
            this.telemetryClient = client;

        private Student(SchoolContext context)
            this.telemetryClient = context.AppInsightsClient;

         //Snip for brevity

This allows the Entity classes to still have an instance of TelemetryClient while still preserving the principles of DDD and allowing direct consumers of your class to instantiate it without any issue.

Also with the magic of .NET Core Activity API, logs generated in a single request are grouped together in a nice visual representation in Application Insights without you having to do anything.

Application Insights Structured Logs

If you have a better way of doing this, dear reader, please let me know in the comments!


Popular posts from this blog

Integrating React with SonarQube using Azure DevOps Pipelines

In the world of automation, code quality is of paramount importance. SonarQube and Azure DevOps are two tools which solve this problem in a continuous and automated way. They play well for a majority of languages and frameworks. However, to make the integration work for React applications still remains a challenge. In this post we will explore how we can integrate a React application to SonarQube using Azure DevOps pipelines to continuously build and assess code quality. Creating the React Application Let's start at the beginning. We will use npx to create a Typescript based React app. Why Typescript? I find it easier to work and more maintainable owing to its strongly-typed behavior. You can very well follow this guide for jsx based applications too. We will use the fantastic Create-React-App (CRA) tool to create a React application called ' sonar-azuredevops-app '. > npx create-react-app sonar-azuredevops-app --template typescript Once the project creation is done, we

Creating a Smart Playlist

A few days earlier I was thinking that wouldn't it be nice if I had something which will automatically generate a playlist for me with no artists repeated. Also, it would be nice if I could block those artists which I really hate (like Himesh Reshammiya!). Since I couldn't find anything already available, I decided to code it myself. Here is the outcome -  This application is created entirely in .NET Framework 4/WPF and uses Windows Media Player Library as its source of information. So you have to keep your Windows Media Player Library updated for this to work. It is tested only on Windows 7/Vista. You can download it from here . UPDATE : You can download the Windows XP version of the application here . Please provide your feedback!

Bhagavad Gita Reader

Few days ago I had a heated argument with my friend about religion. Still fresh from watching " Religulous ", I was countering his every argument. Fed up, he asked me to read Bhagavad Gita and then tell him if I find anything wrong with it. Faced with the prospect of reading a book running into hundreds of pages, I asked him to keep it cool and let it go. He anyways went ahead and gifted me the holy book. Now I don't have the patience or passion to read such a thick religious book (yeah go ahead, judge me), I was thinking of a shortcut. That's when the idea of Bhagavad Gita Reader came into my mind. Snapshot - (Click for a larger view) This application divides Bhagavad Gita into chapters and verses. Then each verse and its translation is shown. There are no extra "interpretations to clutter up your mind." This application is built on WPF/.NET 4.0 with MVVM Light framework - A great framework with a very small learning curve as compared to Prism  albeit