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)
        {
            optionsBuilder.UseSqlServer(@"Server=.\SQLEXPRESS;Database=SchoolDB;Trusted_Connection=True;");
            base.OnConfiguring(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!

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

Use AI to build your house!

When a new housing society emerges, residents inevitably create chat groups to connect and share information using various chat apps like WhatsApp and Telegram. In India, Telegram seems to be the favorite as it provides generous group limits, admin tools, among other features. These virtual communities become treasure troves of invaluable insights. But whatever app you use, there is always a problem of finding the right information at right time. Sure, the apps have a "Search" button, but they are pretty much limited to keyword search and are useless when you have to search through thousands of messages. I found myself in this situation when it was my turn to start on an interior design project for my home. Despite being part of a vibrant Telegram group, where countless residents had shared their experiences with various interior designers and companies, I struggled to unearth the pearls of wisdom buried within the chat's depths. I remembered that I could take advantage o...

Vaastu Shastra

There are certain tasks that the Indian society expects a person to fulfill - get a good job, get married at a certain age, buy a house, buy a car, have kids etc. So it would seem natural to you that after getting married I have started looking around for a house to buy. It isn't so. My hunt for a house began with a trip to the mall to buy a sofa set. It should not come as a surprise that I like movies. I have watched hundreds of movies and now that I have means at my disposal I started to improve my movie viewing experience. With TV and audio system out of the way, a comfy couch was all that was needed. So I dragged my wife with me to the mall and started evaluating the over-priced sofas. We hopped and jumped on a lot of them and when the dust finally settled, my heart was with a sofa that was also a recliner, rocking chair, had foot support, was made of high quality dead skin... err leather - the complete package! It also came with a hefty price tag. We came back home to di...