Using Serilog for Logging in ASP.NET Core

In .NET, there is built-in API that supports logging (Microsoft.Extensions.Logging) and there are many third-party logging providers that implement that API.

For simple use cases, the built-in logging can be sufficient, but for many or our projects at Trailhead, we need a more powerful and flexible logging system. For these projects we often use a third-party provider, and Serilog is often the one we find best for our needs.

Getting Started with Serilog

There are couple NuGet libraries needed to setup Serilog in your ASP.NET Core project:

Once installed and configured, you can write log messages directly through Serilog or any ILogger interface injected by ASP.NET. All loggers will use the same underlying implementation, levels, and destinations. This was ideal for us because we had existing project, with written logs by built-in provider – Microsoft.Extensions.Logging so all we needed to do is to add Serilog configuration.

Configuring Serilog

With Serilog.Settings.Configuration installed, the Serilog settings provider reads from any Microsoft.Extensions.Configuration sources including the appsettings.json file. We added these configurations in our project since this is all we need for now.

Serilog has all kinds of “sinks” that it can use for writing logged events to different types of storage in different formats. For example, you can use sinks to log to Azure or AWS.

If it’s sufficient for your needs, you can also simply log to files. As you can see in configuration code above, there is WriteTo section where you add either “Console” (for Serilog.Sinks.Console when running in development) or ”File” (for Serilog.Sinks.File when running in productio). You can add all kinds of parameters for the File sink. In the example above, I’ve added path and rollingInterval, which can be either Day, Hour, Month, Year, etc. Finally, I used an outputTemplate, which formats the contents of each event log entry.

The last thing I need to do is configure Serilog using this configuration section of the appsettings.json file in Program.cs:

As you can see, configuration is quite simple. There is LoggerConfiguration instance where you should either pull configuration from appsettings.json or hard-code it directly in the code. Here’s an example of that:

It is always better practice to use it from appsetings.json so it can be configurable and override-able in different environments. For example, ASP.NET Core allows you to use a different configuration file on different environments.

When using environment-based configuration files, you could set different environments up differently. For example, you could configure appsetings.Development.json to log to both Console and File, while for appsettings.Production.json you can add also to log to Azure (since you may not want to increase your storage on Azure while doing development).

Conclusion

That’s a quick overview of how to use Serilog in an existing ASP.NET Core project. I hope this will save you some time if you’ve been investigating how to do that and which logging framework to use.

Related Blog Posts

We hope you’ve found this to be helpful and are walking away with some new, useful insights. If you want to learn more, here are a couple of related articles that others also usually find to be interesting:

Our Gear Is Packed and We're Excited to Explore with You

Ready to come with us? 

Together, we can map your company’s tech journey and start down the trails. If you’re set to take the first step, simply fill out the form below. We’ll be in touch – and you’ll have a partner who cares about you and your company. 

We can’t wait to hear from you! 

This field is for validation purposes and should be left unchanged.

Together, we can map your company’s tech journey and start down the trails. If you’re set to take the first step, simply fill out the form below. We’ll be in touch – and you’ll have a partner who cares about you and your company. 

We can’t wait to hear from you! 

Montage Portal

Montage Furniture Services provides furniture protection plans and claims processing services to a wide selection of furniture retailers and consumers.

Project Background

Montage was looking to build a new web portal for both Retailers and Consumers, which would integrate with Dynamics CRM and other legacy systems. The portal needed to be multi tenant and support branding and configuration for different Retailers. Trailhead architected the new Montage Platform, including the Portal and all of it’s back end integrations, did the UI/UX and then delivered the new system, along with enhancements to DevOps and processes.

Logistics

We’ve logged countless miles exploring the tech world. In doing so, we gained the experience that enables us to deliver your unique software and systems architecture needs. Our team of seasoned tech vets can provide you with:

Custom App and Software Development

We collaborate with you throughout the entire process because your customized tech should fit your needs, not just those of other clients.

Cloud and Mobile Applications

The modern world demands versatile technology, and this is exactly what your mobile and cloud-based apps will give you.

User Experience and Interface (UX/UI) Design

We want your end users to have optimal experiences with tech that is highly intuitive and responsive.

DevOps

This combination of Agile software development and IT operations provides you with high-quality software at reduced cost, time, and risk.

Trailhead stepped into a challenging project – building our new web architecture and redeveloping our portals at the same time the business was migrating from a legacy system to our new CRM solution. They were able to not only significantly improve our web development architecture but our development and deployment processes as well as the functionality and performance of our portals. The feedback from customers has been overwhelmingly positive. Trailhead has proven themselves to be a valuable partner.

– BOB DOERKSEN, Vice President of Technology Services
at Montage Furniture Services

Technologies Used

When you hit the trails, it is essential to bring appropriate gear. The same holds true for your digital technology needs. That’s why Trailhead builds custom solutions on trusted platforms like .NET, Angular, React, and Xamarin.

Expertise

We partner with businesses who need intuitive custom software, responsive mobile applications, and advanced cloud technologies. And our extensive experience in the tech field allows us to help you map out the right path for all your digital technology needs.

  • Project Management
  • Architecture
  • Web App Development
  • Cloud Development
  • DevOps
  • Process Improvements
  • Legacy System Integration
  • UI Design
  • Manual QA
  • Back end/API/Database development

We partner with businesses who need intuitive custom software, responsive mobile applications, and advanced cloud technologies. And our extensive experience in the tech field allows us to help you map out the right path for all your digital technology needs.

Our Gear Is Packed and We're Excited to Explore with You

Ready to come with us? 

Together, we can map your company’s tech journey and start down the trails. If you’re set to take the first step, simply fill out the contact form. We’ll be in touch – and you’ll have a partner who cares about you and your company. 

We can’t wait to hear from you! 

This field is for validation purposes and should be left unchanged.

Thank you message.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.